Connectors

• Cloud connectors
  • getGet cloud connectors
  • postAdd cloud connector configuration
  • getGet retrieval information
  • patchUpdate credentials
  • delDelete cloud connector
  • postValidate report name
  • postTest cloud connector configuration

API docs by Redocly

Cloud visibility: Connectors (1.0.0)

Download OpenAPI specification:Download

URL: https://www.snowsoftware.com

API for interacting with cloud connectors.

Cloud connectors

Get cloud connectors

Returns a collection of cloud connectors.

Authorizations:

bearerAuth

query Parameters

page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

https://{region}.snowsoftware.io/api/cloud-visibility/cloud-connectors/v1/connectors

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "pagination": {

  • "page_number": 1,
  • "page_size": 1

  },
• "items": [

  • {

    • "id": "523fei31e32u1295231l579e",
    • "name": "Azure Snow",
    • "type": "Azure",
    • "createdAt": "2019-08-24T14:15:22Z",
    • "status": {

      • "contextId": "802a6d0a-d295-42c7-8856-1e4e1dc62785",
      • "updatedAt": "2019-08-24T14:15:22Z",
      • "type": "inProgress",
      • "errorCode": "Account-Connection-Error"

      }

    }

  ]

}

Add cloud connector configuration

Creates a cloud connector configuration for any supported cloud connector type.

Authorizations:

bearerAuth

Request Body schema: application/json

required

type required	string Enum: "AwsS3" "AzureBlob" The cloud connector type.
	CloudConnectorSaveAWSRequest (object) or CloudConnectorSaveAzureRequest (object) The cloud connector details.
One of bucketName required string The AWS bucket name. reportPrefix required string The AWS report prefix. reportName required string The AWS report name. region required string The AWS region. accessKey required string The AWS access key. secretKey required string The AWS secret key.

Responses

https://{region}.snowsoftware.io/api/cloud-visibility/cloud-connectors/v1/connectors

Request samples

• Payload

Content type

application/json

Example

AwsS3AzureBlobAwsS3

{

• "type": "AwsS3",
• "connectionDetails": {

  • "bucketName": "cv-automation",
  • "reportPrefix": "cv",
  • "reportName": "datareport",
  • "region": "us-east-1",
  • "accessKey": "ADIAZCSR2LUYAYP42KQQ",
  • "secretKey": "khjcfgg3jh42ffFASD@34k2j"

  }

}

Response samples

• 201
• 400
• 500

Content type

application/json

{

• "id": "523fei31e32u1295231l579e",
• "name": "Azure Snow",
• "type": "Azure",
• "createdAt": "2019-08-24T14:15:22Z",
• "status": {

  • "contextId": "802a6d0a-d295-42c7-8856-1e4e1dc62785",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "type": "inProgress",
  • "errorCode": "Account-Connection-Error"

  }

}

Get retrieval information

Returns a collection of retrieval details for a given cloud connector.

Authorizations:

bearerAuth

path Parameters

id required

string The unique ID of the cloud connector for which the retrieval details are returned.

query Parameters

page_number	integer >= 1 Default: 1 The page number.
page_size	integer >= 1 Default: 100 The maximum number of items in the response.

Responses

https://{region}.snowsoftware.io/api/cloud-visibility/cloud-connectors/v1/connectors/{id}/retrievals

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "pagination": {

  • "page_number": 1,
  • "page_size": 1

  },
• "items": [

  • {

    • "contextId": "ecc314f8-49c2-4c33-b2cc-ee44a23ab292",
    • "calendarMonth": "2022-04-01",
    • "updatedAt": "2019-08-24T14:15:22Z",
    • "lastInProgressTime": "2019-08-24T14:15:22Z",
    • "lastSuccessTime": "2019-08-24T14:15:22Z",
    • "type": "inProgress",
    • "errorCode": "Account-Connection-Error"

    }

  ]

}

Update credentials

Modifies the credentials for a given cloud connector.

Authorizations:

bearerAuth

path Parameters

id required

string The unique ID of the cloud connector for which the credentials are modified.

Request Body schema: application/merge-patch+json

required

required	CloudConnectorUpdateCredentialsAWSRequest (object) or CloudConnectorUpdateCredentialsAzureRequest (object) The cloud connector credentials.
One of accessKey required string The AWS access key. secretKey required string The AWS secret key.

Responses

https://{region}.snowsoftware.io/api/cloud-visibility/cloud-connectors/v1/connectors/{id}

Request samples

• Payload

Content type

application/merge-patch+json

Example

AwsS3AzureBlobAwsS3

{

• "credentials": {

  • "accessKey": "ADIAZCSR2LUYAYP42KQQ",
  • "secretKey": "khjcfgg3jh42ffFASD@34k2j"

  }

}

Response samples

• 200
• 400
• 404
• 500

Content type

application/json

{

• "id": "523fei31e32u1295231l579e",
• "name": "Azure Snow",
• "type": "Azure",
• "createdAt": "2019-08-24T14:15:22Z",
• "status": {

  • "contextId": "802a6d0a-d295-42c7-8856-1e4e1dc62785",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "type": "inProgress",
  • "errorCode": "Account-Connection-Error"

  }

}

Delete cloud connector

Removes the given cloud connector.

Authorizations:

bearerAuth

path Parameters

id required

string The unique ID of the cloud connector for which the credentials are deleted.

Responses

https://{region}.snowsoftware.io/api/cloud-visibility/cloud-connectors/v1/connectors/{id}

Response samples

• 202
• 404
• 500

Content type

application/json

{ }

Validate report name

Validates that the given report name is unique across the given cloud connector type. This validation is also done when a cloud connector configuration is created.

Authorizations:

bearerAuth

Request Body schema: application/json

required

type required	string Enum: "AwsS3" "AzureBlob" The cloud connector type.
name required	string The cloud connector name.

Responses

https://{region}.snowsoftware.io/api/cloud-visibility/cloud-connectors/v1/connectors/validate

Request samples

• Payload

Content type

application/json

Example

AwsS3AzureBlobAwsS3

{

• "type": "AwsS3",
• "name": "datareport"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "unique": true

}

Test cloud connector configuration

Tests the cloud connector configuration for any supported cloud connector type. This test is also done when a cloud connector configuration is created.

Authorizations:

bearerAuth

Request Body schema: application/json

required

type required	string Enum: "AwsS3" "AzureBlob" The cloud connector type.
	CloudConnectorSaveAWSRequest (object) or CloudConnectorSaveAzureRequest (object) The cloud connector details.
One of bucketName required string The AWS bucket name. reportPrefix required string The AWS report prefix. reportName required string The AWS report name. region required string The AWS region. accessKey required string The AWS access key. secretKey required string The AWS secret key.

Responses

https://{region}.snowsoftware.io/api/cloud-visibility/cloud-connectors/v1/connectors/test

Request samples

• Payload

Content type

application/json

Example

AwsS3AzureBlobAwsS3

{

• "type": "AwsS3",
• "connectionDetails": {

  • "bucketName": "cv-automation",
  • "reportPrefix": "cv",
  • "reportName": "datareport",
  • "region": "us-east-1",
  • "accessKey": "ADIAZCSR2LUYAYP42KQQ",
  • "secretKey": "khjcfgg3jh42ffFASD@34k2j"

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "status": {

  • "code": "bucketIsEmpty",
  • "message": "bucket does not contain any reports"

  }

}