Rotate a credential secret

POST/credentials/{credential_id}/secret-rotations

Generates 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.

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

credential_id*string

Header Parameters

Idempotency-Key*string

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"  }}