Skip to main content
POST
Rotate API key

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

API key sid (id_ak_…).

Required string length: 18
Pattern: ^id_ak_

Body

application/json

Request body of rotate_api_key.

grace_seconds
integer

0..604800 (≤7d); omit = 24h default; 0 = immediate cutover.

Required range: 0 <= x <= 604800

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
object | null
required
result
object
required
meta
object
required
credits
object