latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-206779363.7 KB

2c3aca3a6e6d

api-keys

Update API key

Updates the name of a specific API key

patch/api/api-keys/{key_id}

Path parameters

key_idstring required

ID of the API key to update

Request body

namestring required

New name for the API key

Response

Successful Response

idstring required

Unique API key identifier with 'apikey_' prefix

namestring nullable

Optional descriptive name for this API key

created_atstring date-time required

When this API key was created

last_used_atstring date-time nullable

When this API key was last used for authentication

is_activeboolean required

Whether this API-key row is enabled rather than explicitly disabled; effective usability also requires a linked, active, unexpired grant

actionsGrantAction[] nullable

Action verbs this key's grant allows; null when the key has no usable grant

library_scope_mode'all_libraries' | 'selected_libraries'

Which of the owner's libraries a credential covers.

all_libraries means all current and future live libraries owned by the user. selected_libraries means only explicitly selected libraries, with no automatic expansion.

selected_library_countinteger nullable

Number of libraries a 'selected_libraries' grant covers; null unless library_scope_mode is 'selected_libraries'