cURL
curl --request GET \
--url 'https://cockroachlabs.cloud/api/v1/clusters/available-regions?provider=SOME_STRING_VALUE&serverless=SOME_BOOLEAN_VALUE&pagination.start_key=SOME_STRING_VALUE&pagination.direction=SOME_STRING_VALUE&pagination.limit=SOME_INTEGER_VALUE&pagination.time=SOME_STRING_VALUE&pagination.order=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'{
"regions": [
{
"name": "<string>",
"location": "<string>",
"provider": "CLOUD_PROVIDER_UNSPECIFIED",
"serverless": true,
"distance": 123
}
],
"pagination": {
"next": "<string>",
"last": "<string>",
"limit": 123,
"time": "2023-11-07T05:31:56Z",
"order": "ASC"
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}List the regions available for new clusters and nodes.
Sort order: Distance (based on client IP address)
GET
/
api
/
v1
/
clusters
/
available-regions
cURL
curl --request GET \
--url 'https://cockroachlabs.cloud/api/v1/clusters/available-regions?provider=SOME_STRING_VALUE&serverless=SOME_BOOLEAN_VALUE&pagination.start_key=SOME_STRING_VALUE&pagination.direction=SOME_STRING_VALUE&pagination.limit=SOME_INTEGER_VALUE&pagination.time=SOME_STRING_VALUE&pagination.order=SOME_STRING_VALUE' \
--header 'Authorization: Bearer REPLACE_BEARER_TOKEN'{
"regions": [
{
"name": "<string>",
"location": "<string>",
"provider": "CLOUD_PROVIDER_UNSPECIFIED",
"serverless": true,
"distance": 123
}
],
"pagination": {
"next": "<string>",
"last": "<string>",
"limit": 123,
"time": "2023-11-07T05:31:56Z",
"order": "ASC"
}
}{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Optional CloudProvider for filtering.
- GCP: The Google Cloud Platform cloud provider.
- AWS: The Amazon Web Services cloud provider.
Available options:
CLOUD_PROVIDER_UNSPECIFIED, GCP, AWS Optional filter to only show regions available for serverless clusters.
Available options:
PAGE_DIRECTION_NEXT, PAGE_DIRECTION_LAST - DESC: Sort in descending order. The default order is ascending.
Available options:
ASC, DESC 
