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

UpdateConnector

Updates a CSPM connector's configuration, such as the scope or regions for the connected cloud provider.

Request Syntax


PATCH /connectors/ConnectorId+ HTTP/1.1
Content-type: application/json

{
   "Description": "string",
   "Provider": { ... }
}

URI Request Parameters

The request uses the following URI parameters.

ConnectorId

The unique identifier of the connector to update.

Pattern: .*\S.*

Required: Yes

Request Body

The request accepts the following data in JSON format.

Description

The updated description of the connector.

Type: String

Pattern: .*\S.*

Required: No

Provider

The updated cloud provider configuration for the connector.

Type: CspmProviderUpdateConfiguration object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConnectorStatus": "string",
   "EnablementStatus": "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.

ConnectorStatus

The connectivity status of the connector after the update.

Type: String

Valid Values: CONNECTED | DEGRADED | FAILED_TO_CONNECT | UNKNOWN

EnablementStatus

The enablement status of the connector after the update.

Type: String

Valid Values: ENABLED | PENDING_ENABLEMENT | PENDING_UPDATE | PENDING_DELETION

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