Skip to main content
PATCH
Update a key’s name / scopes / rate limit / active flag. Cannot rotate the underlying secret — for that, delete and re-create. A key cannot deactivate itself (would lock the caller out mid-request), so trying to set is_active=false on the calling key returns 409.

Path parameters

string (uuid)
required

Request body

UpdateAPIKeyRequest
string,null
string[],null
integer,null
boolean,null

Response

APIKeySummary
string
required
string
required
string
required
First 12 chars of the key (e.g. ‘sk_ss_aBc12’).
string[]
required
integer
required
boolean
required
string,null
string,null
string
required
boolean
True for the key making this request (callers can self-identify).

Status codes