api-keys

List API keys

Changed on

Retrieves a list of all API keys for the current user

get/api/api-keys/

Request

  • Base URL: https://api.gumnut.ai
  • URL: https://api.gumnut.ai/api/api-keys/
  • Auth: HTTP bearer

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'

Changes

  • c3e15c78f2daRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 6397cb5a99c5Revision changes
    • info

      api operation id list_api_keys_api_api_keys__get removed and replaced with list_api_keys

    • info

      the endpoint scheme security clerkSession was added to the API