Rotate a credential secret
/credentials/{credential_id}/secret-rotationsGenerates a new secret for the credential. The credential ID and its policies do not change.
The previous secret remains valid for an overlap period, set by overlap_hours (1 to 168 hours, default 24), so integrations can switch to the new secret without downtime.
The new secret is returned only in this response and cannot be retrieved again. Store it securely.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/credentials/string/secret-rotations" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "object": "secret_rotation", "rotated_at": "2019-08-24T14:15:22Z", "secret": "string" }}Remove a credential policy DELETE
Removes a policy from a credential. The change publishes a new policy revision containing all remaining policies. Removing the last policy is allowed and leaves the credential without access to any resource. A credential cannot modify its own policies.
Sandbox
Next Page