Get All Advanced Clusters

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:

  • Back Up Your Database Deployment for dedicated clusters.
  • Shared Cluster Backups for tenant clusters.
• If "backupEnabled" : false, the cluster doesn't use Atlas backups.

This parameter defaults to false.

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.

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.

Type of the cluster that you want to create.

This API resource accepts REPLICASET, SHARDED, and GEOSHARDED.

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.

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

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

• MONGOD for replica sets, or
• MONGOS for sharded clusters.

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

See also: Seedlist format

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.

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.

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 Google Cloud. 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.

Cloud service provider that offers Encryption at Rest.

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:

• get one Atlas cluster
• get all Atlas clusters
• modify a Atlas cluster

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 5.0.

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

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.

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:

• Sharding
• Number of Nodes

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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:

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.

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.

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.

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.

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.

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.

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.

Cloud service provider on which Atlas provisions the hosts.

• Set dedicated clusters to AWS, GCP, or AZURE.
• Set M2/M5 clusters to TENANT.

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.

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.

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.

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.

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.

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.

Google Cloud Clusters

Google Cloud 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:

Certificate Authority that MongoDB Atlas clusters use. You can specify ISRGROOTX1 (for ISRG Root X1).

Condition in which the API resource finds the cluster when you called the resource. The resource returns one of the following states:

• IDLE
• CREATING
• UPDATING
• DELETING
• DELETED
• REPAIRING