Skip to main content
POST
Rotate an API key
The replacement secret is returned once. Set previous_key_expires_at to overlap the old and new credentials during rollout.

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
string
required

Body

application/json
name
string

Optional replacement key name.

Minimum string length: 1
previous_key_expires_at
string<date-time> | null

Optional expiry for the previous key. Omit to leave it unchanged.

Response

API key rotated

data
object
required
previous_key_expires_at
string<date-time> | null
required
Last modified on August 30, 2026