Skip to main content
POST
Update an API key.

Authorizations

Authorization
string
header
required

Bearer JWT token or API Key (sk-*).

Path Parameters

userId
string
required
key
string
required

Body

application/json
version
number
required

Current API key version used for optimistic concurrency control.

Required range: x >= 0
name
string

You need to provide name of the user.

metadata
object | null

Replacement resource metadata. Top-level keys starting with "__" are reserved for backend use.

restricted
boolean

You can provide if key should be whitelisted.

whitelist
object[] | null

Use an empty array or null when restricted is false; provide at least one complete entry when setting restricted to true.

code
string

Optional six-character confirmation code when required by the account policy.

Required string length: 6

Response

OK.

Last modified on September 5, 2026