Update an API credential

This endpoint updates one or more fields on an existing API credential. 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 and have Can edit access to the API credential.
  • Retrieve the apiCredentialId by calling the /v2/api-credentials endpoint.
  • Omitted fields are left unchanged.
  • If a credential is provided, the provided authentication details (ID, secret, etc.) replace the previous values. To leave secrets unchanged, omit the credential parameter.

Usage scenarios

  • Secret rotation: Update the secret fields for a credential automatically for an external service.
  • Allowlist updates: Expand or restrict the set of hostnames the credential can be used against.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

The request body.

string

New display name.

string | null

New description. Pass null to clear.

allowlist
array of strings

Replacement list of hostname glob patterns. Must not be empty; use ["*"] to allow every host.

allowlist
credential
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