Skip to main content
PATCH
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
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
Minimum length: 1. Maximum length: 128.
string[],null
integer,null
Minimum: 1. Maximum: 10000.
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). Default: false.

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026