SIsigmacomputing
API connectors

Create an API connector

This endpoint creates a new API connector that defines how to call an external HTTP endpoint from within Sigma. For more information on API connectors, see Configure API credentials and connectors in Sigma.

Usage notes

  • The user making this request must be assigned an account type with the Manage API connectors permission enabled.
  • If a credential is provided using the authId parameter, the user making this request must have at least Can view permission on the credential and the request URL must match the credential's allowlist.
  • Retrieve the apiCredentialId (used as authId) by calling the /v2/api-credentials endpoint.

Usage scenarios

  • Programmatic connector setup: Automate creation of API connectors as part of an environment provisioning workflow.
  • Integration onboarding: Create connectors for each external service your workbooks need to interact with.
post/v2/api-connectors

Request

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

Request body

namestring required

Display name of the connector.

descriptionstring

Human-readable description.

authIdstring

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

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.