Delete an API connector

DELETE

/v2/api-connectors/:apiConnectorId

This endpoint archives an API connector, preventing it from being used in new workbook actions. For more information on API connectors, see Configure API credentials and connectors in Sigma.

Usage notes

Retrieve the apiConnectorId by calling the /v2/api-connectors endpoint.
The user making this request must be assigned an account type with the Manage API connectors permission enabled and must have Can edit access to the connector.

Usage scenarios

Cleanup: Remove connectors that are no longer in use to keep the organization’s connector list tidy.
Decommissioning: Archive connectors associated with deprecated or retired external services.

This endpoint archives an API connector, preventing it from being used in new workbook actions. For more information on API connectors, see [Configure API credentials and connectors in Sigma](https://help.sigmacomputing.com/docs/configure-api-credentials-and-connectors-in-sigma). ### Usage notes - Retrieve the **apiConnectorId** by calling the [/v2/api-connectors](https://help.sigmacomputing.com/reference/list-api-connectors) endpoint. - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled and must have **Can edit** access to the connector. ### Usage scenarios - **Cleanup:** Remove connectors that are no longer in use to keep the organization's connector list tidy. - **Decommissioning:** Archive connectors associated with deprecated or retired external services.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

apiConnectorIdstringRequired

Response

The response body.

$	curl -X DELETE https://api.sigmacomputing.com/v2/api-connectors/apiConnectorId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'