List databases for a cluster

Sort order: Database name ascending

GET /api/v1/clusters/{cluster_id}/databases

cURL

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/databases \
  --header 'Authorization: Bearer <token>'

200

{
  "databases": [
    {
      "name": "<string>",
      "table_count": "<string>"
    }
  ],
  "pagination": {
    "next_page": "<string>",
    "previous_page": "<string>"
  }
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

This endpoint is in Preview and subject to change. Refer to the API support policy for more details.

Authorizations

Authorization · string · header · required

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

Path Parameters

cluster_id · string · required

Query Parameters

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.

databases · Database · object[] · required

Show child attributes

pagination · object

Show child attributes