Navigation

Get One Advanced Cluster

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.

Note

This feature is not available for M0 (Free Tier) clusters. For more information, see Atlas M0 (Free Tier) Limitations.

  • Each Atlas project supports up to 25 clusters. Please contact Atlas support for questions or assistance regarding the cluster limit. To contact support, select Support from the left-hand navigation bar of the Atlas UI.

To use this resource, your API Key must have either the Organization Owner or Project Owner roles.

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

GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}
Path Element
Type
Necessity
Description
GROUP-ID
string
Required
Unique identifier for the project in which to create the cluster.
CLUSTER-NAME
string
Required
Name of the cluster to modify.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

status
HTTP response code
envelope
Expected response body
false

This endpoint doesn't use HTTP request body parameters.

Body Parameter
Type
Description
backupEnabled
Boolean

Flag that indicates whether the cluster can perform backups.

  • If true, the cluster can perform backups. You must set this value to true for NVMe clusters.

    Backup uses:

  • If "backupEnabled" : false, the cluster doesn't use Atlas backups.

This parameter defaults to false.

biConnector
object

Configuration settings applied to BI Connector for Atlas on this cluster.

The MongoDB Connector for Business Intelligence for Atlas (BI Connector) is only available for M10 and larger clusters.

The BI Connector is a powerful tool which provides users SQL-based access to their MongoDB databases. As a result, the BI Connector performs operations which may be CPU and memory intensive. Given the limited hardware resources on M10 and M20 cluster tiers, you may experience performance degradation of the cluster when enabling the BI Connector. If this occurs, upgrade to an M30 or larger cluster or disable the BI Connector.

biConnector
.enabled
Boolean
Flag that indicates whether this cluster has BI Connector for Atlas enabled.
biConnector
.readPreference
string

Source from which the BI Connector for Atlas reads data. Each BI Connector for Atlas read preference contains a distinct combination of readPreference and readPreferenceTags options.

This API resource accepts primary, secondary, or analytics.

This parameter defaults to analytics if the cluster includes analytics nodes. If the cluster lacks analyics nodes, the default value is secondary.

To set the readPreference value to "analytics" requires the cluster to have at least one analytics node. Once you have set the readPreference value to "analytics", you must have at least one analytics node in the cluster.

See also: BI Connector Read Preferences Table.

clusterType
string

Type of the cluster that you want to create.

This API resource accepts REPLICASET, SHARDED, and GEOSHARDED.

connectionStrings
object

Set of connection strings that your applications use to connect to this cluster.

Use the parameters in this object to connect your applications to this cluster.

See also: Connection String Options

Atlas returns the contents of this object after the cluster has started, not while it builds the cluster.

connectionStrings
.privateEndpoint
array
Private endpoint connection strings. Each object describes the connection strings you can use to connect to this cluster through a private endpoint. Atlas returns this parameter only if you deployed a private endpoint to all regions to which you deployed this cluster's nodes.
connectionStrings
.privateEndpoint[n]
.connectionString
string
Private-endpoint-aware mongodb://connection string for this private endpoint.
connectionStrings
.privateEndpoint[n]
.endpoints
array
Private endpoint through which you connect to Atlas when you use connectionStrings.privateEndpoint[n].connectionString or connectionStrings.privateEndpoint[n].srvConnectionString.
connectionStrings
.privateEndpoint[n]
.endpoints[n]
.endpointId
string
Unique identifier of the private endpoint.
connectionStrings
.privateEndpoint[n]
.endpoints[n]
.providerName
string
Cloud provider to which you deployed the private endpoint. Atlas returns AWS or AZURE.
connectionStrings
.privateEndpoint[n]
.endpoints[n]
.region
string
Region to which you deployed the private endpoint.
connectionStrings
.privateEndpoint[n]
.srvConnectionString
string

Private-endpoint-aware mongodb+srv:// connection string for this private endpoint.

The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to:

  • Append the seed list or
  • Change the URI if the nodes change.

Use this URI format if your driver supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString.

See also: Seedlist format

connectionStrings
.privateEndpoint[n]
.type
string

Type of MongoDB process that you connect to with the connection strings. Atlas returns:

  • MONGOD for replica sets, or
  • MONGOS for sharded clusters.
connectionStrings
.standard
string
Public mongodb:// connection string for this cluster.
connectionStrings
.standardSrv
string

Public mongodb+srv:// connection string for this cluster.

See also: Seedlist format

connectionStrings
.private
string

Network-peering-endpoint-aware mongodb://connection strings for each interface VPC endpoint you configured to connect to this cluster. Atlas returns this parameter only if you created a network peering connection to this cluster.

For AWS clusters, Atlas doesn't return this parameter unless you enable custom DNS.

connectionStrings
.privateSrv
string

Network-peering-endpoint-aware mongodb+srv:// connection strings for each interface VPC endpoint you configured to connect to this cluster. Atlas returns this parameter only if you created a network peering connection to this cluster.

The mongodb+srv protocol tells the driver to look up the seed list of hosts in DNS. Atlas synchronizes this list with the nodes in a cluster. If the connection string uses this URI format, you don't need to:

  • Append the seed list or
  • Change the URI if the nodes change.

Use this URI format if your driver supports it. If it doesn't, use connectionStrings.private.

See also: Seedlist format

For AWS clusters, Atlas doesn't return this parameter unless you enable custom DNS.

createDate
string
Timestamp in ISO 8601 date and time format in UTC when Atlas created the cluster.
diskSizeGB
number

Capacity, in gigabytes, of the host's root volume. Increase this number to add capacity, up to a maximum possible value of 4096 (i.e., 4 TB). This value must be a positive number.

Set a value for diskSizeGB when you set values for replicationSpecs.

You can't set this value with clusters with local NVMe SSDs.

The minimum disk size for dedicated clusters is 10 GB for AWS and GCP. If you specify diskSizeGB with a lower disk size, Atlas defaults to the minimum disk size value.

If your cluster includes Azure nodes, this value must correspond to an existing Azure disk type (8, 16, 32, 64, 128, 256, 512, 1024, 2048, or 4095)

Atlas calculates storage charges differently depending on whether you choose the default value or a custom value.

The maximum value for disk storage cannot exceed 50 times the maximum RAM for the selected cluster. If you require additional storage space beyond this limitation, consider upgrading your cluster to a higher tier.

If your cluster spans cloud service providers, this value defaults to the minimum default of the providers involved.

See also: Storage Capacity.

encryptionAtRestProvider
string

Cloud service provider that offers Encryption at Rest.

Specify AWS to enable Encryption at Rest using the Atlas project AWS Key Management System settings. The cluster must meet the following requirements:

Parameter
Requirement
replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize
M10 or greater
backupEnabled
false or omitted

You must configure encryption at rest for the Atlas project before enabling it on any cluster in the project.

See also:

groupId
string
Unique 24-hexadecimal digit string that identifies the project in which the cluster resides.
id
string
Unique 24-hexadecimal digit string that identifies the cluster.
labels
array

Collection of key-value pairs that tag and categorize the cluster. Each key and value has a maximum length of 255 characters.

"labels": [
{
"key": "example key",
"value": "example value"
}
]

The Atlas console doesn't display your labels. The API returns the labels in the response body when you use the API to:

mongoDBMajorVersion
string

Version of the cluster to deploy. Atlas supports the following MongoDB versions for M10 or greater clusters:

  • 3.6
  • 4.0
  • 4.2
  • 4.4

If omitted, Atlas deploys a cluster that runs MongoDB 4.4.

If "replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize": "M2" or "M5", deploy MongoDB 4.4.

Atlas always deploys the cluster with the latest stable release of the specified version. You can upgrade to a newer version of MongoDB when you modify a cluster.

mongoDBVersion
string
Version of MongoDB that the cluster runs, in X.Y.Z format.
name
string
Label that identifies this cluster. After Atlas creates the cluster, you can't change its name.
paused
Boolean
Flag that indicates whether the cluster has been paused.
pitEnabled
Boolean
Flag that indicates whether the cluster uses continuous cloud backups.
replicationSpecs
array
Configuration for cluster regions and the hardware provisioned in them.
replicationSpecs[n]
.numShards
number

Positive integer that specifies the number of shards to deploy in each specified zone.

This API resource accepts 1 through 50, inclusive. This parameter defaults to 1.

If you specify a numShards value of 1 and a clusterType of SHARDED, Atlas deploys a single-shard sharded cluster.

Don't create a sharded cluster with a single shard for production environments. Single-shard sharded clusters don't provide the same benefits as multi-shard configurations.

See Also:

replicationSpecs[n]
.regionConfigs
array

Hardware specifications for nodes set for a given region. Each regionConfigs object describes the region's priority in elections and the number and type of MongoDB nodes that Atlas deploys to the region.

Each regionConfigs object must have either an analyticsSpecs object, electableSpecs object, or readOnlySpecs object.

  • Tenant clusters only require electableSpecs.
  • Dedicated clusters can specify any of these specifications, but must have at least one electableSpecs object within a replicationSpec.
  • Every hardware specification must use the same instanceSize.
Example

If you set replicationSpecs[n].regionConfigs[m].analyticsSpecs.instanceSize to M30, you must set replicationSpecs[n].regionConfigs[m].electableSpecs.instanceSize to M30 if you have electable nodes and replicationSpecs[n].regionConfigs[m].readOnlySpecs.instanceSize to M30 if you have read-only nodes.

replicationSpecs[n]
.regionConfigs[m]
.analyticsSpecs
object

Hardware specifications for analytics nodes needed in the region. Analytics nodes handle analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only and can never become the primary.

If you don't specify this parameter, no analytics nodes deploy to this region.

replicationSpecs[n]
.regionConfigs[m]
.analyticsSpecs
.diskIOPS
number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

To change this value from the default, set replicationSpecs[n].regionConfigs[m].analyticsSpecs.ebsVolumeType to PROVISIONED.

Maximum input/output operations per second (IOPS) the cluster can perform. The possible values depend on the selected replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize and diskSizeGB.

This setting requires you to:

  • Set replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize to M30 or greater
  • Not use clusters with local NVMe SSDs.

To view the possible range of IOPS values for the selected instance size and storage capacity:

  1. Open the Atlas web console.
  2. Select Build a New Cluster.
  3. Under Cloud Provider & Region, select AWS.
  4. Under Cloud Provider & Region, select the region corresponding to your configured replicationSpecs[n].regionConfigs[m].regionNamee.
  5. Under Cluster Tier, select the cluster tier corresponding to your configured replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize.
  6. Under Cluster Tier, set the Storage Capacity slider to your configured diskSizeGB. You can also enter the exact value of diskSizeGB in the box to the right of the slider.

Click Provision IOPS to see the available IOPS range.

If you set the diskIOPS value to a value higher than the default value for the selected volume size, Atlas automatically sets replicationSpecs[n].regionConfigs[m].<type>Specs.ebsVolumeType to PROVISIONED. If you manually set diskIOPS to the default value, you must specify replicationSpecs[n].regionConfigs[m].<type>Specs.ebsVolumeType to be either PROVISIONED or STANDARD.

This parameter defaults to the cluster tier's Standard IOPS value, as viewable in the Atlas console.

If you change this value, the cluster cost also changes. To learn more, see billing.

Atlas enforces the following minimum ratios for given cluster tiers. This keeps cluster performance consistent with large datasets.

Instance sizes M10 to M40 have a ratio of disk capacity to system memory of 60:1. Instance sizes greater than M40 have a ratio of 120:1.

Example

To support 3 TB (or 3,072 GB) of disk capacity, select a cluster tier with a minimum of 32 GB of RAM. This would be M50 or greater.

replicationSpecs[n]
.regionConfigs[m]
.analyticsSpecs
.ebsVolumeType
string

Type of storage you want to attach to your AWS-provisioned cluster.

Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

The API resource accepts STANDARD, the default, and PROVISIONED.

  • STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
  • PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.
replicationSpecs[n]
.regionConfigs[m]
.analyticsSpecs
.instanceSize
string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

See Also: Number of Nodes.

If you deploy a Global Cluster, you must choose a instance size of M30 or greater.

Instance Size
Default Storage
Default RAM
M2
2 GB
Shared
M5
5 GB
Shared
M10
10 GB
2 GB
M20
20 GB
4 GB
M30
40 GB
8 GB
M40
80 GB
16 GB
R40
80 GB
16 GB
M40_NVME
380 GB
15.25 GB
M50
160 GB
32 GB
R50
160 GB
32 GB
M50_NVME
760 GB
30.5 GB
M60
320 GB
64 GB
R60
320 GB
64 GB
M60_NVME
1.6 TB
61 GB
M80
760 GB
131 GB
R80
750 GB
122 GB
M80_NVME
1.6 TB
122 GB
M100
1 TB
160 GB
M140
1 TB
192 GB
M200
1.5 TB
256 GB
R200
1.5 TB
256 GB
M200_NVME
3.1 TB
244 GB
M300
2 TB
384 GB
R300
2 TB
384 GB
R400
3 TB
488 GB
M400_NVME
4 TB
512 GB
R700
4 TB
768 GB

Can use this tier for a multi-cloud cluster.

Unavailable in the AP_SOUTHEAST_2 region.

Availability limited to the following regions:

  • US_EAST_1
  • US_EAST_2
  • US_WEST_2
  • EU_WEST_1
  • EU_CENTRAL_1
  • AP_NORTHEAST_1

Atlas supports the following cluster tiers. Atlas supports deploying M2 and M5 tiers into a subset of available regions. The documentation for replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize includes a list of these regions.

Note
Cluster Tier Naming Conventions

Cluster tier names that are:

  • Appended with _NVME (M40_NVME for example) use direct attached NVMe storage for exceptional performance with the most I/O-intensive workloads.
  • Prepended with R instead of an M (R40 for example) run a low CPU version of the cluster.
replicationSpecs[n]
.regionConfigs[m]
.analyticsSpecs
.nodeCount
number

Number of analytics nodes for Atlas to deploy to the region. Analytics nodes are useful for handling analytic data such as reporting queries from BI Connector for Atlas. Analytics nodes are read-only, and can never become the primary.

replicationSpecs[n]
.regionConfigs[m]
.autoScaling
object

Collection of settings that configures auto-scaling information for the cluster.

The values for the .autoScaling parameter must be the same for every item in the replicationSpecs array.

replicationSpecs[n]
.regionConfigs[m]
.autoScaling
.diskGB
.enabled
Boolean

Flag that indicates whether this cluster enables disk auto-scaling. This parameter defaults to true.

  • Set to true to enable disk auto-scaling.
  • Set to false to disable disk auto-scaling.

The maximum amount of RAM for the selected cluster tier and the oplog size can limit storage auto-scaling. To learn more, see Customize Your Storage.

replicationSpecs[n]
.regionConfigs[m]
.autoScaling
.compute
object

Collection of settings that configure how a cluster might scale its instance size and whether the cluster can scale down.

Cluster tiers with Low CPU or NVME storage classes can't use auto-scaling.

replicationSpecs[n]
.regionConfigs[m]
.autoScaling
.compute
.enabled
Boolean

Flag that indicates whether instance size auto-scaling is enabled. This parameter defaults to false.

  • Set to true to enable instance size auto-scaling. If enabled, you must specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.maxInstanceSize.
  • Set to false to disable instance size auto-scaling.
replicationSpecs[n]
.regionConfigs[m]
.autoScaling
.compute
.scaleDownEnabled
Boolean

Flag that indicates whether the instance size may scale down. Atlas requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute.enabled" : true.

If you enable this option, specify a value for replicationSpecs[n].regionConfigs[m].autoScaling.compute.minInstanceSize.

replicationSpecs[n]
.regionConfigs[m]
.autoScaling
.compute
.minInstanceSize
string
Minimum instance size to which your cluster can automatically scale (such as M10). Atlas requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute. scaleDownEnabled" : true.
replicationSpecs[n]
.regionConfigs[m]
.autoScaling
.compute
.maxInstanceSize
string
Maximum instance size to which your cluster can automatically scale (such as M40). Atlas requires this parameter if "replicationSpecs[n].regionConfigs[m].autoScaling.compute .enabled" : true.
replicationSpecs[n]
.regionConfigs[m]
.backingProviderName
string

Cloud service provider on which you provision the host for a multi-tenant cluster.

Use this setting only when "replicationSpecs[n].regionConfigs[m].providerName" : "TENANT" and "replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize": M2 or M5.

The API resource accepts the following values:

AWS
Amazon AWS
GCP
Google Cloud Platform
AZURE
Microsoft Azure
TENANT

M2 or M5 multi-tenant cluster

Use replicationSpecs[n].regionConfigs[m].backingProviderName to set the cloud service provider.

replicationSpecs[n]
.regionConfigs[m]
.electableSpecs
number

Hardware specifications for electable nodes in the region. Electable nodes can become the primary and can enable local reads.

If you do not specify this option, no electable nodes are deployed to the region.

replicationSpecs[n]
.regionConfigs[m]
.electableSpecs
.diskIOPS
number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

To change this value from the default, set .ebsVolumeType to PROVISIONED.

Maximum input/output operations per second (IOPS) the cluster can perform. The possible values depend on the selected replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize and diskSizeGB.

This setting requires you to:

  • Set replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize to M30 or greater
  • Not use clusters with local NVMe SSDs.

To view the possible range of IOPS values for the selected instance size and storage capacity:

  1. Open the Atlas web console.
  2. Select Build a New Cluster.
  3. Under Cloud Provider & Region, select AWS.
  4. Under Cloud Provider & Region, select the region corresponding to your configured replicationSpecs[n].regionConfigs[m].regionNamee.
  5. Under Cluster Tier, select the cluster tier corresponding to your configured replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize.
  6. Under Cluster Tier, set the Storage Capacity slider to your configured diskSizeGB. You can also enter the exact value of diskSizeGB in the box to the right of the slider.

Click Provision IOPS to see the available IOPS range.

If you set the diskIOPS value to a value higher than the default value for the selected volume size, Atlas automatically sets replicationSpecs[n].regionConfigs[m].<type>Specs.ebsVolumeType to PROVISIONED. If you manually set diskIOPS to the default value, you must specify replicationSpecs[n].regionConfigs[m].<type>Specs.ebsVolumeType to be either PROVISIONED or STANDARD.

This parameter defaults to the cluster tier's Standard IOPS value, as viewable in the Atlas console.

If you change this value, the cluster cost also changes. To learn more, see billing.

Atlas enforces the following minimum ratios for given cluster tiers. This keeps cluster performance consistent with large datasets.

Instance sizes M10 to M40 have a ratio of disk capacity to system memory of 60:1. Instance sizes greater than M40 have a ratio of 120:1.

Example

To support 3 TB (or 3,072 GB) of disk capacity, select a cluster tier with a minimum of 32 GB of RAM. This would be M50 or greater.

replicationSpecs[n]
.regionConfigs[m]
.electableSpecs
.ebsVolumeType
string

Type of storage you want to attach to your AWS-provisioned cluster.

Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

The API resource accepts STANDARD, the default, and PROVISIONED.

  • STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
  • PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.
replicationSpecs[n]
.regionConfigs[m]
.electableSpecs
.instanceSize
string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

See Also: Number of Nodes.

If you deploy a Global Cluster, you must choose a instance size of M30 or greater.

Instance Size
Default Storage
Default RAM
M2
2 GB
Shared
M5
5 GB
Shared
M10
10 GB
2 GB
M20
20 GB
4 GB
M30
40 GB
8 GB
M40
80 GB
16 GB
R40
80 GB
16 GB
M40_NVME
380 GB
15.25 GB
M50
160 GB
32 GB
R50
160 GB
32 GB
M50_NVME
760 GB
30.5 GB
M60
320 GB
64 GB
R60
320 GB
64 GB
M60_NVME
1.6 TB
61 GB
M80
760 GB
131 GB
R80
750 GB
122 GB
M80_NVME
1.6 TB
122 GB
M100
1 TB
160 GB
M140
1 TB
192 GB
M200
1.5 TB
256 GB
R200
1.5 TB
256 GB
M200_NVME
3.1 TB
244 GB
M300
2 TB
384 GB
R300
2 TB
384 GB
R400
3 TB
488 GB
M400_NVME
4 TB
512 GB
R700
4 TB
768 GB

Can use this tier for a multi-cloud cluster.

Unavailable in the AP_SOUTHEAST_2 region.

Availability limited to the following regions:

  • US_EAST_1
  • US_EAST_2
  • US_WEST_2
  • EU_WEST_1
  • EU_CENTRAL_1
  • AP_NORTHEAST_1

Atlas supports the following cluster tiers. Atlas supports deploying M2 and M5 tiers into a subset of available regions. The documentation for replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize includes a list of these regions.

Note
Cluster Tier Naming Conventions

Cluster tier names that are:

  • Appended with _NVME (M40_NVME for example) use direct attached NVMe storage for exceptional performance with the most I/O-intensive workloads.
  • Prepended with R instead of an M (R40 for example) run a low CPU version of the cluster.
replicationSpecs[n]
.regionConfigs[m]
.electableSpecs
.nodeCount
number

Number of electable nodes for Atlas to deploy to the region. Electable nodes can become the primary and can enable local reads.

The combined electableSpecs.nodeCount across all replicationSpecs[n].regionConfigs[m] objects must total 3, 5, or 7.

You cannot create electable nodes if the replicationSpecs[n].regionConfigs[m].priority is 0.

replicationSpecs[n]
.regionConfigs[m]
.priority
Integer

Precedence is given to this region when a primary election occurs.

If your regionConfigs has only .readOnlySpecs, .analyticsSpecs, or both, set this value to 0.

If you have multiple regionConfigs objects (your cluster is multi-region or multi-cloud), they must have priorities in descending order. The highest priority is 7.

Example

Set your highest priority region to 7, your second-highest priority to 6, and your third-priority region to 5. If you have no electable nodes, set this value to 0.

If your region has set .electableSpecs.nodeCount to 1 or higher, it must have a priority of exactly one (1) less than another region in the replicationSpecs[n].regionConfigs[m] array. The highest-priority region must have a priority of 7. The lowest possible priority is 1.

The priority 7 region identifies the Preferred Region of the cluster. Atlas places the primary node in the Preferred Region. Priorities 1 through 7 are exclusive: you can't assign a given priority to more than one region per cluster.

Example

If you have three regions, their priorities would be 7, 6, and 5 respectively. If you added two more regions for supporting electable nodes, the priorities of those regions would be 4 and 3 respectively.

replicationSpecs[n]
.regionConfigs[m]
.providerName
string

Cloud service provider on which Atlas provisions the hosts.

  • Set dedicated clusters to AWS, GCP, or AZURE.
  • Set shared tier clusters (M2 or M5) to TENANT.
AWS
Amazon AWS
GCP
Google Cloud Platform
AZURE
Microsoft Azure
TENANT

M2 or M5 multi-tenant cluster

Use replicationSpecs[n].regionConfigs[m].backingProviderName to set the cloud service provider.

M2 and M5 clusters are multi-tenant deployments. You must set this parameter to TENANT and specify the cloud service provider in replicationSpecs[n].regionConfigs[m].backingProviderName.

replicationSpecs[n]
.regionConfigs[m]
.readOnlySpecs
object

Hardware specifications for read-only nodes in the region. Read-only nodes can never become the primary member, but can enable local reads.

If you don't specify this parameter, no read-only nodes are deployed to the region.

replicationSpecs[n]
.regionConfigs[m]
.readOnlySpecs
.diskIOPS
number

Target throughput (IOPS) desired for AWS storage attached to your cluster.

Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

To change this value from the default, set .ebsVolumeType must be PROVISIONED.

Maximum input/output operations per second (IOPS) the cluster can perform. The possible values depend on the selected replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize and diskSizeGB.

This setting requires you to:

  • Set replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize to M30 or greater
  • Not use clusters with local NVMe SSDs.

To view the possible range of IOPS values for the selected instance size and storage capacity:

  1. Open the Atlas web console.
  2. Select Build a New Cluster.
  3. Under Cloud Provider & Region, select AWS.
  4. Under Cloud Provider & Region, select the region corresponding to your configured replicationSpecs[n].regionConfigs[m].regionNamee.
  5. Under Cluster Tier, select the cluster tier corresponding to your configured replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize.
  6. Under Cluster Tier, set the Storage Capacity slider to your configured diskSizeGB. You can also enter the exact value of diskSizeGB in the box to the right of the slider.

Click Provision IOPS to see the available IOPS range.

If you set the diskIOPS value to a value higher than the default value for the selected volume size, Atlas automatically sets replicationSpecs[n].regionConfigs[m].<type>Specs.ebsVolumeType to PROVISIONED. If you manually set diskIOPS to the default value, you must specify replicationSpecs[n].regionConfigs[m].<type>Specs.ebsVolumeType to be either PROVISIONED or STANDARD.

This parameter defaults to the cluster tier's Standard IOPS value, as viewable in the Atlas console.

If you change this value, the cluster cost also changes. To learn more, see billing.

Atlas enforces the following minimum ratios for given cluster tiers. This keeps cluster performance consistent with large datasets.

Instance sizes M10 to M40 have a ratio of disk capacity to system memory of 60:1. Instance sizes greater than M40 have a ratio of 120:1.

Example

To support 3 TB (or 3,072 GB) of disk capacity, select a cluster tier with a minimum of 32 GB of RAM. This would be M50 or greater.

replicationSpecs[n]
.regionConfigs[m]
.readOnlySpecs
.ebsVolumeType
string

Type of storage you want to attach to your AWS-provisioned cluster.

Set only if you selected AWS as your cloud service provider. You can't set this parameter for a multi-cloud cluster.

The API resource accepts STANDARD, the default, and PROVISIONED.

  • STANDARD volume types can't exceed the default IOPS rate for the selected volume size.
  • PROVISIONED volume types must fall within the allowable IOPS range for the selected volume size.
replicationSpecs[n]
.regionConfigs[m]
.readOnlySpecs
.instanceSize
string

Hardware specification for the instance sizes in this region. Each instance size has a default storage and memory capacity. The instance size you select applies to all the data-bearing hosts in your instance size.

See Also: Number of Nodes.

If you deploy a Global Cluster, you must choose a instance size of M30 or greater.

Instance Size
Default Storage
Default RAM
M2
2 GB
Shared
M5
5 GB
Shared
M10
10 GB
2 GB
M20
20 GB
4 GB
M30
40 GB
8 GB
M40
80 GB
16 GB
R40
80 GB
16 GB
M40_NVME
380 GB
15.25 GB
M50
160 GB
32 GB
R50
160 GB
32 GB
M50_NVME
760 GB
30.5 GB
M60
320 GB
64 GB
R60
320 GB
64 GB
M60_NVME
1.6 TB
61 GB
M80
760 GB
131 GB
R80
750 GB
122 GB
M80_NVME
1.6 TB
122 GB
M100
1 TB
160 GB
M140
1 TB
192 GB
M200
1.5 TB
256 GB
R200
1.5 TB
256 GB
M200_NVME
3.1 TB
244 GB
M300
2 TB
384 GB
R300
2 TB
384 GB
R400
3 TB
488 GB
M400_NVME
4 TB
512 GB
R700
4 TB
768 GB

Can use this tier for a multi-cloud cluster.

Unavailable in the AP_SOUTHEAST_2 region.

Availability limited to the following regions:

  • US_EAST_1
  • US_EAST_2
  • US_WEST_2
  • EU_WEST_1
  • EU_CENTRAL_1
  • AP_NORTHEAST_1

Atlas supports the following cluster tiers. Atlas supports deploying M2 and M5 tiers into a subset of available regions. The documentation for replicationSpecs[n].regionConfigs[m].<type>Specs.instanceSize includes a list of these regions.

Note
Cluster Tier Naming Conventions

Cluster tier names that are:

  • Appended with _NVME (M40_NVME for example) use direct attached NVMe storage for exceptional performance with the most I/O-intensive workloads.
  • Prepended with R instead of an M (R40 for example) run a low CPU version of the cluster.
replicationSpecs[n]
.regionConfigs[m]
.readOnlySpecs
.nodeCount
number
Number of read-only nodes for Atlas to deploy to the region. Read-only nodes can never become the primary, but can enable local reads.
replicationSpecs[n]
.regionConfigs[m]
.regionName
string

Physical location of your MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases.

When Atlas deploys a dedicated cluster, Atlas checks if a VPC or VPC connection exists for that provider and region. If not, Atlas creates them as part of the deployment. Atlas assigns the VPC a CIDR block.

To limit a new VPC peering connection to one CIDR block and region, create the connection first. Deploy the cluster after the connection starts.

GCP Clusters
GCP Atlas clusters use a default CIDR block of /18. If your application requires a smaller block, create a network peering container first. Atlas limits the clusters you create to the regions in this new container you created.
Multi-Region Clusters
Multi-region clusters require one VPC peering connection for each region. MongoDB nodes can use only the peering connection that resides in the same region as the nodes to communicate with the peered VPC.

To learn more, see Set up a Network Peering Connection.

Select your cloud service provider's tab for example cluster region names:

  • US_EAST_1
  • US_WEST_2
  • EU_WEST_1

For a complete list of supported AWS regions, see Amazon Web Services (AWS).

replicationSpecs[n]
.zoneName
string
Name for the zone in a Global Cluster. Provide this value if you set clusterType to GEOSHARDED.
rootCertType
string

Certificate Authority that MongoDB Atlas clusters use. You can specify one of the following values:

  • DST: IdenTrust's DST Root CA X3
  • ISRGROOTX1: ISRG Root X1

Atlas triggers a rolling restart of all the nodes in your cluster after 30 minutes when you switch between certificate roots. You can verify the change after the cluster restarts.

If omitted, this setting defaults to IdenTrust's root Certificate Authority (DST Root CA X3).

Note

Atlas cluster TLS certificates use IdenTrust's root Certificate Authority (DST Root CA X3) by default until 30 April 2021. Beginning on 1 May 2021, new TLS certificates that MongoDB Atlas creates will use ISRG instead of IdenTrust for their root Certificate Authority in line with Let's Encrypt's announcement of this transition.

stateName
string

Condition in which the API resource finds the cluster when you called the resource. The possible states are:

  • IDLE
  • CREATING
  • UPDATING
  • DELETING
  • DELETED
  • REPAIRING
1curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
2 --header "Content-Type: application/json" \
3 --include \
4 --request GET "https://cloud.mongodb.com/api/atlas/v1.5/groups/{GROUP-ID}/clusters/basicReplicaSet?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 201 Created
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
1{
2 "backupEnabled": true,
3 "biConnector": {
4 "enabled": false,
5 "readPreference": "secondary"
6 },
7 "clusterType": "REPLICASET",
8 "connectionStrings": {},
9 "createDate": "2021-03-02T22:25:18Z",
10 "diskSizeGB": 10.0,
11 "encryptionAtRestProvider": "NONE",
12 "groupId": "{GROUP-ID}",
13 "id": "{CLUSTER-ID}",
14 "labels": [],
15 "mongoDBMajorVersion": "4.4",
16 "mongoDBVersion": "4.4.4",
17 "name": "basicReplicaSet",
18 "paused": false,
19 "pitEnabled": true,
20 "replicationSpecs": [
21 {
22 "id": "{CLUSTER-ZONE-1}",
23 "numShards": 1,
24 "regionConfigs": [
25 {
26 "analyticsSpecs": {
27 "instanceSize": "M10",
28 "diskIOPS": 100,
29 "ebsVolumeType": "STANDARD",
30 "nodeCount": 0
31 },
32 "electableSpecs": {
33 "instanceSize": "M10",
34 "diskIOPS": 100,
35 "ebsVolumeType": "STANDARD",
36 "nodeCount": 3
37 },
38 "priority": 7,
39 "providerName": "AWS",
40 "readOnlySpecs": {
41 "instanceSize": "M10",
42 "diskIOPS": 100,
43 "ebsVolumeType": "STANDARD",
44 "nodeCount": 0
45 },
46 "regionName": "US_EAST_1"
47 }
48 ],
49 "zoneName": "Zone 1"
50 }
51 ],
52 "rootCertType": "DST",
53 "stateName": "CREATING"
54}
Give Feedback