Sign in
Admin API Keys

Update an API key

put/admin/api-keys/{id}

Path parameters

idstring required

API key ID

Request body

namestring

Name for the API key

descriptionstring

Description of the API key purpose

isActiveboolean

Whether the key is active

expiresAtstring

Expiration date in ISO format, or null to remove

Response

idstring required

Unique identifier

namestring required

Name of the API key

descriptionstring

Description

keyPrefixstring required

Key prefix for identification (first 8 chars)

isActiveboolean required

Whether the key is active

lastUsedAtstring

Last time the key was used

expiresAtstring

Expiration date

createdAtstring required

Creation timestamp

updatedAtstring required

Update timestamp

Changes

No recorded changes to this endpoint across all 1 revision of this API.