v1

latestOpenAPI 3.0.02026-07-2634192196.8 KB
api-keys

List API keys

Lists all API keys for the workspace associated with the Management API key.

get/api-keys

Query parameters

type'public' | 'secret' | 'proxy'

Filters by API key type.

status'enabled' | 'disabled'

Filters by API key status.

environmentstring

Filters by environment ID.

cursorstring

Cursor token used for pagination. Response will contain items appearing after the given cursor.

limitnumber

Sets the maximum number of items contained in a single page.

Headers

X-API-Versionstring required

Management API version.

Response

List of API keys matching the given query.

Example response

{
  "data": [
    {
      "id": "tok_No3jUysGLCDuqB3RnCVf1weo",
      "name": "My Public Key",
      "description": "Description for my public key",
      "status": "enabled",
      "type": "public",
      "token": "eWDrrpGGLjDQW0LBA0Wj",
      "rate_limit": 5,
      "created_at": "2024-05-31T01:24:39.506Z"
    }
  ],
  "metadata": {
    "pagination": {
      "next_cursor": "eyJrZXlzIjpbImlkIl0sInZhbHVlcyI6WyJhZV9JRVdWQVhrQURyN3BiNFYzI"
    }
  }
}
All 34 operations