List API Keys

Sort order: created_at

Can be used by the following roles assigned at the organization scope:

• ORG_ADMIN
• CLUSTER_ADMIN
• AUDITOR

GET /api/v1/api-keys

cURL

cURL

curl --request GET \
  --url 'https://cockroachlabs.cloud/api/v1/api-keys?service_account_id=SOME_STRING_VALUE&pagination.page=SOME_STRING_VALUE&pagination.limit=SOME_INTEGER_VALUE&pagination.as_of_time=SOME_STRING_VALUE&pagination.sort_order=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

200

{
  "api_keys": [
    {
      "created_at": "2022-03-22T20:23:11.285067Z",
      "id": "CCDB1_12345abcdefGHIJKLMnopq",
      "name": "example name",
      "service_account_id": "1234abcd-1234-1234-abcd-12345678abcd"
    }
  ],
  "pagination": {
    "next_page": "<string>",
    "previous_page": "<string>"
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

service_account_id · string

Optional filter to limit the response to include only api keys for a specific service account.

pagination.page · string

pagination.limit · integer<int32>

pagination.as_of_time · string<date-time>

pagination.sort_order · enum<string>

• ASC: Sort in ascending order. This is the default unless otherwise specified.
• DESC: Sort in descending order.

Available options: ASC, DESC

Response

200

application/json

A successful response.

api_keys · object[] · required

The api keys matching the request filters.

Show child attributes

pagination · object

Show child attributes