Admiral

Api keys

List API keys

GET
/v1/api-keys

Scope: apikey:read

Authorization

bearerAuth
AuthorizationBearer <token>

An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...

In: header

Query Parameters

filter?filter

Filter expression to narrow results. Uses the Admiral filter DSL (see the API documentation for the full operator and predicate reference).

Filterable fields:

  • name: filter by key name.
  • status: filter by key status (API_KEY_STATUS_ACTIVE, API_KEY_STATUS_REVOKED).

Example: field['status'] = 'API_KEY_STATUS_ACTIVE'

Lengthlength <= 1024
page_size?page_size

Maximum number of keys to return per page. Defaults to 50 when omitted or 0; must not exceed 100.

Formatint32
Range0 <= value <= 100
page_token?page_token

Opaque pagination token from a previous response.

Response Body

application/json

curl -X GET "https://example.com/v1/api-keys"
{  "api_keys": [    {      "id": "string",      "name": "string",      "scopes": [        "string"      ],      "status": "API_KEY_STATUS_UNSPECIFIED",      "expires_at": "2023-01-15T01:30:15.01Z",      "last_used_at": "2023-01-15T01:30:15.01Z",      "revoked_at": "2023-01-15T01:30:15.01Z",      "created_by": {        "id": "string",        "display_name": "string",        "email": "string"      },      "created_at": "2023-01-15T01:30:15.01Z"    }  ],  "next_page_token": "string"}