This endpoint archives an API credential so it can no longer be associated with new API connectors. 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.
• Archiving a credential does not automatically unbind any API connectors that reference it.

Usage scenarios

• Credential decommissioning: Remove credentials for decommissioned services or expired tokens.
• Security cleanup: Archive compromised or rotated credentials to prevent accidental reuse.