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.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request body.

string
required

Display name of the connector.

params
object
required
string

Human-readable description.

config
object
string

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

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json