Sigma REST APIAPI credentials

Update an API credential

View as MarkdownOpen in Claude
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](https://help.sigmacomputing.com/docs/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](https://help.sigmacomputing.com/reference/list-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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

apiCredentialIdstringRequired

Request

The request body.
namestringOptional
New display name.
descriptionstring or nullOptional

New description. Pass null to clear.

allowlistlist of stringsOptional

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

credentialobjectOptional

Response

The response body.
apiCredentialIdstring
Unique identifier of the API credential.
namestring
Display name of the credential.
authMethodenum
Authentication method the credential uses.
allowlistlist of strings

Hostname glob patterns (e.g. *.example.com) that the credential is authorized to be used against.

credentialobject

Nonsensitive projection of the credential, discriminated by authMethod. Secret fields (password, token, clientSecret, secretAccessKey) are never returned.

createdBystring
The identifier of the user who created this object.
updatedBystring
The identifier of the user or process that last updated this object.
createdAtdatetime
When the object was created.
updatedAtdatetime
When the object was last updated.
descriptionstring

Human-readable description.