Skip to main content
PUT
Update an API key

Authorizations

Authorization
string
header
required

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

Path Parameters

api_key
string
required

The API key ID. Example: key_01jz8v2q4x...

Query Parameters

include
enum<string>[]
Available options:
creator
fields[api-keys]
enum<string>[]
Available options:
name,
token,
abilities,
created_at,
last_used_at,
expires_at
fields[users]
enum<string>[]
Available options:
name,
email,
created_at,
updated_at

Body

application/json
name
string
required

The name of the API key.

Maximum string length: 255

Response

ApiKeyResource

data
ApiKeyResource · object
required
included
UserResource · object[]