H2h2o
API Keys

List API keys.

Allows admins to list all existing API keys.

get/admin/api_keys

Request

Query parameters

offsetinteger

How many API keys to skip before returning.

limitinteger

How many API keys to return.

filterstring

Only returns keys for usernames matching this filter.

Response

Successful operation

idstring required

The unique identifier of the API key

usernamestring required

The username of the user this key belongs to

namestring required

The name of the API key

hintstring required

Hint for the secret key of the API key

created_atstring date-time required

The date and time of when the API key was created

expires_atstring date-time

The date and time of the API key expiration

last_used_atstring date-time

The date and time of the most recent API call using this key

inactivity_intervalinteger

The number of days this API key can be inactive for before becoming invalid

total_callsinteger required

Number of times this API key has been used

is_activeboolean required

Status denoting if the API key is active or not

collection_namestring

The name of the collection associated with the API key (if it has been configured to a collection)

collection_idstring

The id of the collection associated with the API key (if it has been configured to a collection)

is_global_keyboolean required

Status denoting if the API key is global or collection specific

Changes

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