List the regions available for new clusters and nodes

Sort order: Distance (based on client IP address)

This endpoint may be used by any member of the organization.

GET /api/v1/clusters/available-regions

cURL

cURL

curl --request GET \
  --url 'https://cockroachlabs.cloud/api/v1/clusters/available-regions?provider=SOME_STRING_VALUE&serverless=SOME_BOOLEAN_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

{
  "regions": [
    {
      "distance": 123,
      "location": "<string>",
      "name": "<string>",
      "provider": "GCP",
      "serverless": true
    }
  ],
  "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

provider · enum<string>

Optional CloudProvider for filtering.

• GCP: The Google Cloud Platform cloud provider.
• AWS: The Amazon Web Services cloud provider.
• AZURE: The Azure cloud provider.

Available options: GCP, AWS, AZURE

serverless · boolean · default: false

Optional filter to only show regions available for serverless clusters.

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.

regions · object[] · required

Show child attributes

pagination · object

Show child attributes