Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListConnectors

Lists the CSPM connectors and their metadata for the calling account.

Request Syntax


GET /connectors?ConnectorStatus=ConnectorStatus&EnablementStatus=EnablementStatus&MaxResults=MaxResults&NextToken=NextToken&ProviderName=ProviderName HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ConnectorStatus

The connectivity status to filter connectors by.

Valid Values: CONNECTED | DEGRADED | FAILED_TO_CONNECT | UNKNOWN

EnablementStatus

The enablement status to filter connectors by.

Valid Values: ENABLED | PENDING_ENABLEMENT | PENDING_UPDATE | PENDING_DELETION

MaxResults

The maximum number of results to return.

Valid Range: Minimum value of 1. Maximum value of 100.

NextToken

The pagination token to request the next page of results.

ProviderName

The name of the cloud provider to filter connectors by.

Valid Values: AZURE

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Connectors": [ 
      { 
         "ConnectorArn": "string",
         "ConnectorId": "string",
         "CreatedAt": "string",
         "CreatedBy": "string",
         "Description": "string",
         "EnablementStatus": "string",
         "Name": "string",
         "ProviderSummary": { 
            "ConnectorStatus": "string",
            "ProviderConfiguration": { ... },
            "ProviderName": "string"
         }
      }
   ],
   "NextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Connectors

An array of connector summaries.

Type: Array of CspmConnectorSummary objects

NextToken

The pagination token to use to request the next page of results. If there are no additional results, this value is null.

Type: String

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You don't have permission to perform the action specified in the request.

HTTP Status Code: 403

ConflictException

The request causes conflict with the current state of the service resource.

HTTP Status Code: 409

InternalServerException

The request has failed due to an internal failure of the service.

HTTP Status Code: 500

InvalidAccessException

The account doesn't have permission to perform this action.

HTTP Status Code: 401

ResourceNotFoundException

The request was rejected because we can't find the specified resource.

HTTP Status Code: 404

ThrottlingException

The limit on the number of requests per second was exceeded.

HTTP Status Code: 429

ValidationException

The request has failed validation because it's missing required fields or has invalid inputs.

HTTP Status Code: 400