SIsigmacomputing
API connectors

Update an API connector

This endpoint updates one or more fields on an existing API connector. 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.
  • Omitted fields are left unchanged. Pass null for authId to remove the credential association.

Usage scenarios

  • Endpoint migration: Update the connector URL or parameters when an external API changes its interface.
  • Credential rotation: Rebind the connector to a new credential after rotating secrets.
patch/v2/api-connectors/{apiConnectorId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

apiConnectorIdstring required

Request body

namestring

New display name.

descriptionstring nullable

New description. Pass null to clear.

authIdstring nullable

New credential binding. Pass null to remove the credential.

Response

The response body.

apiConnectorIdstring required

Unique identifier of the API connector.

namestring required

Display name of the connector.

createdBystring required

The identifier of the user who created this object.

updatedBystring required

The identifier of the user or process that last updated this object.

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

descriptionstring

Human-readable description.

authIdstring nullable

Identifier of the API credential (apiCredentialId) used to authenticate requests. null if unauthenticated.

Changes

No recorded changes to this operation across all 1 revision of this API.