Navigation

Get All Cloud Provider Regions

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

To use this resource, your API Key must have the Project Read Only role.

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

GET /groups/{GROUP-ID}/clusters/provider/regions?provider={AWS|GCP|Azure}&tier={tier}&crossCloudProvider={true|false}
Path Parameter
Type
Necessity
Description
GROUP-ID
Required
string
Unique identifier for the project containing the cloud provider regions and cluster tiers you want to retrieve.
Name
Type
Necessity
Description
Default
pageNum
integer
Optional
Page number, starting with one, that Atlas returns of the total number of objects.
1
itemsPerPage
integer
Optional
Number of items that Atlas returns per page, up to a maximum of 500.
100
includeCount
boolean
Optional
Flag that indicates whether Atlas returns the totalCount parameter in the response body.
true
pretty
boolean
Optional
Flag that indicates whether Atlas returns the JSON response in the prettyprint format.
false
envelope
boolean
Optional

Flag that indicates whether Atlas wraps the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body.

false
provider
string
Optional
Cloud providers that the response includes.
tier
string
Optional
Cluster tiers that the response includes.
crossCloudProvider
Boolean
Optional
Flag that indicates whether the response should be limited to tiers and regions that support multi-cloud clusters.

This endpoint doesn't use HTTP request body parameters.

provider
string
Cloud providers that the response includes. Allowable values include AWS, GCP, and AZURE.
instanceSizes
array
List of instances sizes that this cloud provider supports.
instanceSizes[n].availableRegions
array
List of regions that this cloud provider supports for this instance size.
instanceSizes[n].availableRegions[m].name
string

Label that identifies the supported region.

See also:

instanceSizes[n].availableRegions[m].default
Boolean

Flag that indicates whether the cloud provider sets this region as its default.

  • AWS defaults to US_EAST_1.
  • GCP defaults to CENTRAL_US.
  • AZURE defaults to US_WEST_2.
instanceSizes[n].name
string
Label that identifies the instance size or cluster tier.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
--include \
--request GET "https://cloud.mongodb.com/api/atlas/v1.0//groups/{GROUP-ID}/clusters/provider/regions?provider={AWS|GCP|Azure}&tier={tier}&crossCloudProvider={true|false}?pretty=true"
HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
1{
2 "links":[
3 {
4 "rel":"self",
5 "href":"http://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/clusters/provider/regions?provider=AWS&provider=GCP&tier=M80&tier=R80&pageNum=1&itemsPerPage=100"
6 }
7 ],
8 "totalCount":2,
9 "results":[
10 {
11 "provider":"AWS",
12 "instanceSizes":[
13 {
14 "availableRegions":[
15 {
16 "name": "US_EAST_1",
17 "default": true
18 },
19 {
20 "name": "US_EAST_2",
21 "default": false
22 }
23 ],
24 "name":"M80"
25 },
26 {
27 "availableRegions":[
28 {
29 "name": "US_EAST_1",
30 "default": true
31 },
32 {
33 "name": "US_EAST_2",
34 "default": false
35 }
36 ],
37 "name":"R80"
38 }
39 ]
40 },
41 {
42 "provider":"GCP",
43 "instanceSizes":[
44 {
45 "availableRegions":[
46 {
47 "name": "US_EAST_1",
48 "default": true
49 },
50 {
51 "name": "US_EAST_2",
52 "default": false
53 }
54 ],
55 "name":"M80"
56 }
57 ]
58 }
59 ]
60}
Give Feedback