List clusters in the organization

{ "clusters": [ { "account_id": "", "cidr_range": "172.28.0.0/14", "cloud_provider": "GCP", "cockroach_version": "v21.2.4", "config": { "serverless": { "routing_id": "example-cluster-1533", "upgrade_type": "AUTOMATIC", "usage_limits": { "provisioned_virtual_cpus": "2" } } }, "created_at": "2022-03-22T20:23:11.285067Z", "creator_id": "7cde0cd9-0d8a-4008-8f90-45092ce8afc1", "id": "35c4abb2-bb66-46d7-afed-25ebef5ed2aa", "is_customer_cloud_account": false, "labels": { "cost_center": "12345", "env": "prod" }, "name": "example-cluster", "operation_status": "UNSPECIFIED", "plan": "STANDARD", "regions": [ { "internal_dns": "internal-free-tier7.gcp-us-central1.crdb.io", "name": "us-central1", "node_count": 0, "private_endpoint_dns": "private-free-tier7.gcp-us-central1.crdb.io", "sql_dns": "free-tier7.gcp-us-central1.crdb.io", "ui_dns": "" } ], "state": "CREATED", "updated_at": "2022-03-22T20:23:11.879593Z", "upgrade_status": "UPGRADE_AVAILABLE" } ], "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

show_inactive

boolean

default:false

If true, show clusters that have been deleted or failed to initialize. Note that inactive clusters will only be included if the requesting user has organization-scoped cluster read permissions.

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

pagination.sort_by

enum<string>

NAME: Sort by cluster name. This is the default unless otherwise specified.
CREATED_AT: Sort by cluster created_at.
DELETED_AT: Sort by cluster deleted_at. Active clusters will be sorted by created_at.

Available options:

NAME,

CREATED_AT,

DELETED_AT

Response

A successful response.

clusters

object[]

required

Show child attributes

pagination

object

Show child attributes