api-keys

Create API key

Changed on

Creates a new API key for the current user

post/api/api-keys/

Request

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

Request body

namestring required

Descriptive name identifying this API key

actionsGrantAction[] required

Action verbs the key may perform (at least one). read is required whenever any broader action is selected. Pass all four actions for a full-access key.

library_scope_mode'all_libraries' | 'selected_libraries' required

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.

library_idsstring[] nullable

Libraries the key covers. Required (at least one) when library_scope_mode is selected_libraries; not allowed otherwise. Up to 200 ids.

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'

api_keystring required

The actual API key value - store this securely as it cannot be retrieved later

Changes

  • 815e0302a988Revision changes
    • breaking

      response property detail list-of-types was widened by adding types string to media type application/json of response 422

    • info

      the response property became required for the status

  • 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