Rotate an API key
Mints a replacement with the same name, scopes, allowlist and expiry and returns its secret once. The old key keeps working until the grace period ends (max 7 days). Optional JSON body { "grace": "7d" }.
Authorizations
Authorization: Bearer rbk_live_...
The API release your integration is built against, e.g. 2026-10-01.wattle. Required on every request.
Path Parameters
The id of the object.
"key_3K1nTq8cZ5yWvR2mPd7Lx9"
Response
The replacement key, with its secret
"key_3K1nTq8cZ5yWvR2mPd7Lx9"
api_key First 16 characters of the secret, for display
account:read, connections:read, connections:write, data:read, categories:read, categories:write, destinations:read, destinations:write, syncs:read, syncs:write, rules:read, rules:write, events:read, events:write, keys:write Created before scopes existed; holds every :read scope
Only present on create and rotate responses
"2026-08-21T09:30:00.000Z"
Set after rotate: when this key stops working
"2026-08-21T09:30:00.000Z"
"2026-08-21T09:30:00.000Z"
active, expiring, revoked, expired Up to 50 string pairs. Set a key to null in an update to unset it.
"2026-08-21T09:30:00.000Z"
"2026-08-21T09:30:00.000Z"