List nodes for a cluster

Sort order: Region name, node name

Can be used by the following roles assigned at the organization, folder or cluster scope:

• ORG_ADMIN
• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER
• CLUSTER_DEVELOPER

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

cURL

cURL

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

200

{
  "nodes": [
    {
      "name": "<string>",
      "region_name": "<string>"
    }
  ],
  "pagination": {
    "next_page": "<string>",
    "previous_page": "<string>"
  }
}

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

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

region_name · string

Optional filter to limit response to a single region.

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.

nodes · object[] · required

Show child attributes

pagination · object

Show child attributes