Modify connector

PATCH

Modify a connector

Path parameters

integrationIdstringRequired

Headers

x-org-api-keystringRequired

Request

This endpoint expects an object.
authConfigmap from strings to anyOptional

Authentication configuration for the connector. This object contains the necessary credentials and settings required to authenticate with the external service. You can get the required configuration fields from the GET /api/v1/connectors/{connectorId}/config endpoint.

limitedActionslist of stringsOptional

A list of actions that are limited or restricted for the connector. This can be used to specify which actions the connector is allowed or not allowed to perform. The list of possible actions can be found in the API documentation.

enabledbooleanOptional

Flag to indicate if the connector is enabled. When set to false, the connector will not process any requests. You can toggle this value to temporarily disable the connector without deleting it. Default value can be found in the GET /api/v1/connectors/{connectorId} endpoint response.

Response

statusstring

Status of the patch operation. Returns ‘success’ when the connector is successfully updated. For detailed information about possible status values, refer to the API documentation at PATCH /api/v1/connectors/{connectorId}.

List action enums
Built with