Skip to main content
PATCH
Update an API key

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Body

environment
string<uuid>
name
string

Friendly name for the API key

Required string length: 1 - 255
scopes
enum<string>[]
  • read - read
  • write - write
  • admin - admin
Available options:
read,
write,
admin
rate_limit
integer

Requests per hour, from 1 to 100,000. A value outside that range is refused with a 400 that names rate_limit.

Required range: 1 <= x <= 100000
is_active
boolean
expires_at
string<date-time> | null

Response

200 - application/json
id
string<uuid>
required
read-only
organization
string<uuid>
required
read-only
organization_name
string
required
read-only
environment
string<uuid>
required
environment_name
string
required
read-only
environment_slug
string
required
read-only
name
string
required

Friendly name for the API key

Maximum string length: 255
prefix
string
required
read-only
scopes
enum<string>[]
required
  • read - read
  • write - write
  • admin - admin
Available options:
read,
write,
admin
last_used_at
string<date-time> | null
required
read-only
created_at
string<date-time>
required
read-only
rate_limit
integer

Requests per hour, from 1 to 100,000. A value outside that range is refused with a 400 that names rate_limit.

Required range: 1 <= x <= 100000
is_active
boolean
expires_at
string<date-time> | null