Create an API credential

This endpoint creates a new API credential for use with API connectors and the Call API action in Sigma. For more information on API credentials, 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.
  • The allowlist parameter is required and must contain at least one hostname glob pattern. Use ["*"] to allow the credential to be used against any host.
  • The following authentication methods are supported: basic, bearer, apiKey, oAuthClientCredentials, oAuthAuthorizationCode, oAuthPasswordCredentials, awsSigV4.
  • Secret fields are encrypted at rest and are never returned in subsequent read responses.

Usage scenarios

  • Credential provisioning: Automate credential creation as part of environment setup or onboarding.
  • Multi-service authentication: Create separate credentials for each external service, with allowlists scoped to only that service's domains.
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 credential.

allowlist
array of strings
required

Hostname glob patterns the credential may be used against (e.g. ["*.example.com"]). Required and must not be empty; use ["*"] to allow every host.

allowlist*
credential
required
string

Human-readable description.

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