Skip to main content
PATCH
Update API key

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Body

Reject any request fields not declared on the serializer.

name
string
Maximum string length: 250
scopes
object[]

Replace the key's full scope set. Pass an empty list to unscope the key. Each entry's role is re-validated against your current role on the workspace.

Response

The updated API key.

id
string
required
name
string
required
prefix
string
required
created_at
string<date-time>
required
expires_at
string<date-time> | null
required
scopes
object[]
required
read-only