Skip to main content
PATCH
Update an API key

Headers

authorization
string
Minimum string length: 1
x-organization-id
string
Minimum string length: 1

Path Parameters

keyId
string
required

Body

application/json
name
string
Required string length: 1 - 120
scopes
string[]
Maximum array length: 50
Minimum string length: 1

Response

Default Response

id
string
required
organizationId
string
required
name
string
required
prefix
string
required
scopes
string[]
required
createdByUserId
null | string
required
lastUsedAt
null | string<date-time>
required
expiresAt
null | string<date-time>
required
revokedAt
null | string<date-time>
required
status
enum<string>
required
Available options:
active,
expired,
revoked
metadata
null | object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required