Skip to main content
PATCH
Update API key

Authorizations

Authorization
string
header
required

Pass an API key or JWT token. API keys can be sent as Authorization: Bearer <key> or Authorization: <key>.

Path Parameters

api_key_id
string
required

The API key's unique identifier.

Body

application/json
name
string
Required string length: 1 - 255
scopes
enum<string>[]

Permission scope for an API key. admin grants all permissions.

Available options:
upload,
download,
metadata,
delete,
admin
status
enum<string>
Available options:
active,
disabled,
revoked
metadata
object | null

Response

API key updated.

status
enum<string>
Available options:
SUCCESS
message
string
data
object
timestamp
string<date-time>