Find available regions (HTTP)
|
For details about additional languages, see: |
Gets a list of available regions for database creation.
|
You need an application token with permission to create and configure databases, such as the Organization Administrator role. For more information, see Get endpoint and token. |
Result
Returns 200 Success and an object that contains information about the available regions.
Example response:
[
{
"classification": "standard",
"cloudProvider": "GCP",
"displayName": "Moncks Corner, South Carolina",
"enabled": true,
"name": "us-east1",
"region_type": "serverless",
"reservedForQualifiedUsers": false,
"zone": "na"
},
{
"classification": "standard",
"cloudProvider": "AWS",
"displayName": "Asia Pacific (Mumbai)",
"enabled": true,
"name": "ap-south-1",
"region_type": "serverless",
"reservedForQualifiedUsers": true,
"zone": "apac"
}
]Parameters
Use the DevOps API to get information about available regions programmatically.
The application token must have sufficient permissions to perform the requested operations, such as the Database Administrator role.
Command signature
curl -sS -L -X GET "https://api.astra.datastax.com/v2/regions/serverless?region-type=REGION_TYPE&filter-by-org=FILTER_BY_ORG" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json"| Name | Type | Summary |
|---|---|---|
|
|
Optional. Only return regions that support specific database types. Can be one of:
Default: "" |
|
|
Optional. Whether to only return regions that can be used by the caller’s organization. Can be one of: Default: |
Examples
The following examples demonstrate how to find available regions.
curl -sS -L -X GET "https://api.astra.datastax.com/v2/regions/serverless" \
--header "Authorization: Bearer APPLICATION_TOKEN" \
--header "Content-Type: application/json"