Upgrade One Shared-Tier Cluster
Upgrades a shared-tier cluster to a Flex or Dedicated (M10+) cluster in the specified project. To use this resource, the requesting Service Account or API Key must have the Project Cluster Manager role. Each project supports up to 25 clusters.
This endpoint can also be used to upgrade Flex clusters that were created using the createCluster API or former M2/M5 clusters that have been migrated to Flex clusters, using instanceSizeName to “M2” or “M5” until January 2026. This functionality will be available until January 2026, after which it will only be available for M0 clusters. Please use the upgradeFlexCluster endpoint instead.
Path parameters
-
Unique 24-hexadecimal digit string that identifies your project. Use the /groups endpoint to retrieve all projects to which the authenticated user has access.
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.
Format should match the following pattern:
^([a-f0-9]{24})$
.
Query parameters
-
Flag that indicates whether Application wraps the response in an
envelope
JSON object. 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. Application adds the status parameter to the response body.Default value is
false
. -
Flag that indicates whether the response body should be in the prettyprint format.
Default value is
false
.Prettyprint
Body
Required
Details of the shared-tier cluster upgrade in the specified project.
-
If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set acceptDataRisksAndForceReplicaSetReconfig to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Reconfiguring a Replica Set during a regional outage -
Group of settings that configures a subset of the advanced configuration details.
Hide advancedConfiguration attributes Show advancedConfiguration attributes object
-
The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when
tlsCipherConfigMode
is set toCUSTOM
.Values are
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
orTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
. -
Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.
Values are
TLS1_0
,TLS1_1
, orTLS1_2
.This option corresponds to the `netssldisabledProtocols` `mongod` configuration file option -
The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
Values are
CUSTOM
orDEFAULT
.
-
-
Range of instance sizes to which your cluster can scale.
Cluster Auto-Scaling Hide autoScaling attributes Show autoScaling attributes object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
Hide compute attributes Show compute attributes object
-
Flag that indicates whether instance size reactive auto-scaling is enabled.
- Set to
true
to enable instance size reactive auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to
false
to disable instance size reactive auto-scaling.
Default value is
false
. - Set to
-
Flag that indicates whether predictive instance size auto-scaling is enabled.
- Set to
true
to enable predictive instance size auto-scaling. MongoDB Cloud requires autoScaling.compute.enabled istrue
in order to enable this feature. - Set to
false
to disable predictive instance size auto-scaling.
Default value is
false
. - Set to
-
Flag that indicates whether the cluster tier can scale down via reactive auto-scaling. This is required if autoScaling.compute.enabled is
true
. If you enable this option, specify a value for providerSettings.autoScaling.compute.minInstanceSize.Default value is
false
.
-
-
Flag that indicates whether someone enabled disk auto-scaling for this cluster.
Default value is
false
.
-
-
Flag that indicates whether the cluster can perform backups. If set to
true
, the cluster can perform backups. You must set this value totrue
for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set tofalse
, the cluster doesn't use MongoDB Cloud backups. -
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.
MongoDB Connector for Business Intelligence Hide biConnector attributes Show biConnector attributes object
-
Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster.
-
Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to
ANALYTICS
node, orSECONDARY
if there are noANALYTICS
nodes.Values are
PRIMARY
,SECONDARY
, orANALYTICS
.Read preferences for BI Connector
-
-
Configuration of nodes that comprise the cluster.
Values are
REPLICASET
,SHARDED
, orGEOSHARDED
. -
Config Server Management Mode for creating or updating a sharded cluster.
When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.
When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.
Values are
ATLAS_MANAGED
orFIXED_TO_DEDICATED
. Default value isATLAS_MANAGED
.MongoDB Sharded Cluster Config Servers -
Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.
This value is not configurable on M0/M2/M5 clusters.
MongoDB Cloud requires this parameter if you set replicationSpecs.
If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value.
Storage charge calculations depend 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 more storage space, consider upgrading your cluster to a higher tier.
Minimum value is
10
, maximum value is4096
. -
Disk warming mode selection.
Values are
FULLY_WARMED
orVISIBLE_EARLIER
. Default value isFULLY_WARMED
.Reduce Secondary Disk Warming Impact -
Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize setting must be
M10
or higher and"backupEnabled" : false
or omitted entirely.Values are
NONE
,AWS
,AZURE
, orGCP
.Encryption at Rest using Customer Key Management -
Set this field to configure the Sharding Management Mode when creating a new Global Cluster.
When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.
When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.
This setting cannot be changed once the cluster is deployed.
Creating a Global Cluster -
Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.
Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
Human-readable labels applied to this MongoDB Cloud component.
Resource Tags -
MongoDB employee granted access level and expiration for a cluster.
Hide mongoDBEmployeeAccessGrant attributes Show mongoDBEmployeeAccessGrant attributes object
-
Expiration date for the employee access grant. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
-
Level of access to grant to MongoDB Employees.
Values are
CLUSTER_DATABASE_LOGS
,CLUSTER_INFRASTRUCTURE
, orCLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA
.
-
-
MongoDB major version of the cluster.
On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for project LTS versions endpoint.
On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.
Available MongoDB Versions in Atlas -
Version of MongoDB that the cluster runs.
Format should match the following pattern:
([\d]+\.[\d]+\.[\d]+)
. -
Human-readable label that identifies the cluster.
Format should match the following pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]*$
. -
Number of shards up to 50 to deploy for a sharded cluster. The resource returns
1
to indicate a replica set and values of2
and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.Minimum value is
1
, maximum value is50
. Default value is1
.Sharding -
Flag that indicates whether the cluster is paused.
-
Flag that indicates whether the cluster uses continuous cloud backups.
Continuous Cloud Backups -
Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to
true
, the cluster can perform backups. If this and backupEnabled are set tofalse
, the cluster doesn't use MongoDB Cloud backups. providerSettings
object One of: Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Range of instance sizes to which your cluster can scale.
Hide autoScaling attribute Show autoScaling attribute object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
Hide compute attributes Show compute attributes object
-
Maximum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M100
,M140
,M200
,M300
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,R700
,M40_NVME
,M50_NVME
,M60_NVME
,M80_NVME
,M200_NVME
, orM400_NVME
. -
Minimum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M100
,M140
,M200
,M300
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,R700
,M40_NVME
,M50_NVME
,M60_NVME
,M80_NVME
,M200_NVME
, orM400_NVME
.
-
-
-
Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform.
-
Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled.
Default value is
true
. -
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M100
,M140
,M200
,M300
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,R700
,M40_NVME
,M50_NVME
,M60_NVME
,M80_NVME
,M200_NVME
, orM400_NVME
. -
Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud 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.
Values are
US_GOV_WEST_1
,US_GOV_EAST_1
,US_EAST_1
,US_EAST_2
,US_WEST_1
,US_WEST_2
,CA_CENTRAL_1
,EU_NORTH_1
,EU_WEST_1
,EU_WEST_2
,EU_WEST_3
,EU_CENTRAL_1
,EU_CENTRAL_2
,AP_EAST_1
,AP_NORTHEAST_1
,AP_NORTHEAST_2
,AP_NORTHEAST_3
,AP_SOUTHEAST_1
,AP_SOUTHEAST_2
,AP_SOUTHEAST_3
,AP_SOUTHEAST_4
,AP_SOUTH_1
,AP_SOUTH_2
,SA_EAST_1
,CN_NORTH_1
,CN_NORTHWEST_1
,ME_SOUTH_1
,ME_CENTRAL_1
,AF_SOUTH_1
,EU_SOUTH_1
,EU_SOUTH_2
,IL_CENTRAL_1
,CA_WEST_1
,AP_SOUTHEAST_5
,AP_SOUTHEAST_7
,MX_CENTRAL_1
, orGLOBAL
.AWS -
Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title="Amazon Web Services">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (
STANDARD
), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (PROVISIONED
). You must set this value to (PROVISIONED
) for NVMe clusters.Values are
STANDARD
orPROVISIONED
.
Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Range of instance sizes to which your cluster can scale.
Hide autoScaling attribute Show autoScaling attribute object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
Hide compute attributes Show compute attributes object
-
Maximum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M90
,M200
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,M60_NVME
,M80_NVME
,M200_NVME
,M300_NVME
,M400_NVME
, orM600_NVME
. -
Minimum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M90
,M200
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,M60_NVME
,M80_NVME
,M200_NVME
,M300_NVME
,M400_NVME
, orM600_NVME
.
-
-
-
Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected providerSettings.instanceSizeName applies.
Values are
P2
,P3
,P4
,P6
,P10
,P15
,P20
,P30
,P40
, orP50
.Disk type -
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M90
,M200
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,M60_NVME
,M80_NVME
,M200_NVME
,M300_NVME
,M400_NVME
, orM600_NVME
. -
Microsoft Azure Regions.
Values are
US_CENTRAL
,US_EAST
,US_EAST_2
,US_NORTH_CENTRAL
,US_WEST
,US_SOUTH_CENTRAL
,EUROPE_NORTH
,EUROPE_WEST
,US_WEST_CENTRAL
,US_WEST_2
,US_WEST_3
,CANADA_EAST
,CANADA_CENTRAL
,BRAZIL_SOUTH
,BRAZIL_SOUTHEAST
,AUSTRALIA_CENTRAL
,AUSTRALIA_CENTRAL_2
,AUSTRALIA_EAST
,AUSTRALIA_SOUTH_EAST
,GERMANY_WEST_CENTRAL
,GERMANY_NORTH
,SWEDEN_CENTRAL
,SWEDEN_SOUTH
,SWITZERLAND_NORTH
,SWITZERLAND_WEST
,UK_SOUTH
,UK_WEST
,NORWAY_EAST
,NORWAY_WEST
,INDIA_CENTRAL
,INDIA_SOUTH
,INDIA_WEST
,CHINA_EAST
,CHINA_NORTH
,ASIA_EAST
,JAPAN_EAST
,JAPAN_WEST
,ASIA_SOUTH_EAST
,KOREA_CENTRAL
,KOREA_SOUTH
,FRANCE_CENTRAL
,FRANCE_SOUTH
,SOUTH_AFRICA_NORTH
,SOUTH_AFRICA_WEST
,UAE_CENTRAL
,UAE_NORTH
, orQATAR_CENTRAL
.Azure
Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Range of instance sizes to which your cluster can scale.
Hide autoScaling attribute Show autoScaling attribute object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
Hide compute attributes Show compute attributes object
-
Maximum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M140
,M200
,M250
,M300
,M400
,R40
,R50
,R60
,R80
,R200
,R300
,R400
, orR600
. -
Minimum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M140
,M200
,M250
,M300
,M400
,R40
,R50
,R60
,R80
,R200
,R300
,R400
, orR600
.
-
-
-
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M140
,M200
,M250
,M300
,M400
,R40
,R50
,R60
,R80
,R200
,R300
,R400
, orR600
. -
Google Compute Regions.
Values are
EASTERN_US
,EASTERN_US_AW
,US_EAST_4
,US_EAST_4_AW
,US_EAST_5
,US_EAST_5_AW
,US_WEST_2
,US_WEST_2_AW
,US_WEST_3
,US_WEST_3_AW
,US_WEST_4
,US_WEST_4_AW
,US_SOUTH_1
,US_SOUTH_1_AW
,CENTRAL_US
,CENTRAL_US_AW
,WESTERN_US
,WESTERN_US_AW
,NORTH_AMERICA_NORTHEAST_1
,NORTH_AMERICA_NORTHEAST_2
,NORTH_AMERICA_SOUTH_1
,SOUTH_AMERICA_EAST_1
,SOUTH_AMERICA_WEST_1
,WESTERN_EUROPE
,EUROPE_NORTH_1
,EUROPE_WEST_2
,EUROPE_WEST_3
,EUROPE_WEST_4
,EUROPE_WEST_6
,EUROPE_WEST_8
,EUROPE_WEST_9
,EUROPE_WEST_10
,EUROPE_WEST_12
,EUROPE_SOUTHWEST_1
,EUROPE_CENTRAL_2
,MIDDLE_EAST_CENTRAL_1
,MIDDLE_EAST_CENTRAL_2
,MIDDLE_EAST_WEST_1
,AUSTRALIA_SOUTHEAST_1
,AUSTRALIA_SOUTHEAST_2
,AFRICA_SOUTH_1
,EASTERN_ASIA_PACIFIC
,NORTHEASTERN_ASIA_PACIFIC
,SOUTHEASTERN_ASIA_PACIFIC
,ASIA_EAST_2
,ASIA_NORTHEAST_2
,ASIA_NORTHEAST_3
,ASIA_SOUTH_1
,ASIA_SOUTH_2
, orASIA_SOUTHEAST_2
.GCP
Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Range of instance sizes to which your cluster can scale.
Hide autoScaling attribute Show autoScaling attribute object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.
-
-
Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when providerSettings.providerName is
TENANT
and providerSetting.instanceSizeName isM0
,M2
orM5
.Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward.
Values are
AWS
,GCP
, orAZURE
.createFlexCluster API -
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set providerSettings.providerName to
TENANT
and specify the cloud service provider in providerSettings.backingProviderName.Values are
M0
,M2
, orM5
.
Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when providerSettings.providerName is
FLEX
and providerSetting.instanceSizeName isFLEX
.Values are
AWS
,GCP
, orAZURE
. -
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set providerSettings.providerName to
FLEX
and specify the cloud service provider in providerSettings.backingProviderName.Value is
FLEX
.
-
-
Set this field to configure the replica set scaling mode for your cluster.
By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.
When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.
When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
Values are
SEQUENTIAL
,WORKLOAD_TYPE
, orNODE_TYPE
. Default value isWORKLOAD_TYPE
.Modify the Replica Set Scaling Mode -
Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use replicationSpecs instead.
Values are
3
,5
, or7
. Default value is3
. -
Physical location where MongoDB Cloud provisions cluster nodes.
Hide replicationSpec attribute Show replicationSpec attribute object
-
Physical location where MongoDB Cloud provisions cluster nodes.
Hide * attributes Show * attributes object
-
Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use replicationSpecs[n].{region}.analyticsNodes instead.
-
Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use replicationSpecs[n].{region}.electableNodes instead.
Values are
0
,3
,5
, or7
. -
Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to
7
. The primary node runs in the Preferred Region. To identify a read-only region, set this parameter to0
.Minimum value is
0
, maximum value is7
. -
Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use replicationSpecs[n].{region}.readOnlyNodes instead.
-
-
-
List of settings that configure your cluster regions.
- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.
- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.
Hide replicationSpecs attributes Show replicationSpecs attributes object
-
Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.
If you include existing zones in the request, you must specify this parameter.
If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.
Format should match the following pattern:
^([a-f0-9]{24})$
. -
Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to
1
and clusterType isSHARDED
, MongoDB Cloud 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.If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.
Default value is
1
. -
Physical location where MongoDB Cloud provisions cluster nodes.
Hide regionsConfig attribute Show regionsConfig attribute object
-
Physical location where MongoDB Cloud provisions cluster nodes.
Hide * attributes Show * attributes object
-
Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use replicationSpecs[n].{region}.analyticsNodes instead.
-
Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use replicationSpecs[n].{region}.electableNodes instead.
Values are
0
,3
,5
, or7
. -
Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to
7
. The primary node runs in the Preferred Region. To identify a read-only region, set this parameter to0
.Minimum value is
0
, maximum value is7
. -
Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use replicationSpecs[n].{region}.readOnlyNodes instead.
-
-
-
Human-readable label that identifies the zone in a Global Cluster. Provide this value only if clusterType is
GEOSHARDED
.
-
Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group.
Value is
ISRGROOTX1
. Default value isISRGROOTX1
. -
List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.
Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example,
environment : production
.Resource Tags Hide tags attributes Show tags attributes object
-
Constant that defines the set of the tag. For example,
environment
in theenvironment : production
tag.Minimum length is
1
, maximum length is255
. -
Variable that belongs to the set of the tag. For example,
production
in theenvironment : production
tag.Minimum length is
1
, maximum length is255
.
-
-
Flag that indicates whether termination protection is enabled on the cluster. If set to
true
, MongoDB Cloud won't delete the cluster. If set tofalse
, MongoDB Cloud will delete the cluster.Default value is
false
. -
Method by which the cluster maintains the MongoDB versions. If value is
CONTINUOUS
, you must not specify mongoDBMajorVersion.Values are
LTS
orCONTINUOUS
. Default value isLTS
.
Responses
-
OK
Hide response attributes Show response attributes object
-
If reconfiguration is necessary to regain a primary due to a regional outage, submit this field alongside your topology reconfiguration to request a new regional outage resistant topology. Forced reconfigurations during an outage of the majority of electable nodes carry a risk of data loss if replicated writes (even majority committed writes) have not been replicated to the new primary node. MongoDB Atlas docs contain more information. To proceed with an operation which carries that risk, set acceptDataRisksAndForceReplicaSetReconfig to the current date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Reconfiguring a Replica Set during a regional outage -
Group of settings that configures a subset of the advanced configuration details.
Hide advancedConfiguration attributes Show advancedConfiguration attributes object
-
The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when
tlsCipherConfigMode
is set toCUSTOM
.Values are
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
orTLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
. -
Minimum Transport Layer Security (TLS) version that the cluster accepts for incoming connections. Clusters using TLS 1.0 or 1.1 should consider setting TLS 1.2 as the minimum TLS protocol version.
Values are
TLS1_0
,TLS1_1
, orTLS1_2
.This option corresponds to the `netssldisabledProtocols` `mongod` configuration file option -
The TLS cipher suite configuration mode. The default mode uses the default cipher suites. The custom mode allows you to specify custom cipher suites for both TLS 1.2 and TLS 1.3.
Values are
CUSTOM
orDEFAULT
.
-
-
Range of instance sizes to which your cluster can scale.
Cluster Auto-Scaling Hide autoScaling attributes Show autoScaling attributes object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
Hide compute attributes Show compute attributes object
-
Flag that indicates whether instance size reactive auto-scaling is enabled.
- Set to
true
to enable instance size reactive auto-scaling. If enabled, you must specify a value for providerSettings.autoScaling.compute.maxInstanceSize. - Set to
false
to disable instance size reactive auto-scaling.
Default value is
false
. - Set to
-
Flag that indicates whether predictive instance size auto-scaling is enabled.
- Set to
true
to enable predictive instance size auto-scaling. MongoDB Cloud requires autoScaling.compute.enabled istrue
in order to enable this feature. - Set to
false
to disable predictive instance size auto-scaling.
Default value is
false
. - Set to
-
Flag that indicates whether the cluster tier can scale down via reactive auto-scaling. This is required if autoScaling.compute.enabled is
true
. If you enable this option, specify a value for providerSettings.autoScaling.compute.minInstanceSize.Default value is
false
.
-
-
Flag that indicates whether someone enabled disk auto-scaling for this cluster.
Default value is
false
.
-
-
Flag that indicates whether the cluster can perform backups. If set to
true
, the cluster can perform backups. You must set this value totrue
for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set tofalse
, the cluster doesn't use MongoDB Cloud backups. -
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.
MongoDB Connector for Business Intelligence Hide biConnector attributes Show biConnector attributes object
-
Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster.
-
Data source node designated for the MongoDB Connector for Business Intelligence on MongoDB Cloud. The MongoDB Connector for Business Intelligence on MongoDB Cloud reads data from the primary, secondary, or analytics node based on your read preferences. Defaults to
ANALYTICS
node, orSECONDARY
if there are noANALYTICS
nodes.Values are
PRIMARY
,SECONDARY
, orANALYTICS
.Read preferences for BI Connector
-
-
Configuration of nodes that comprise the cluster.
Values are
REPLICASET
,SHARDED
, orGEOSHARDED
. -
Config Server Management Mode for creating or updating a sharded cluster.
When configured as ATLAS_MANAGED, atlas may automatically switch the cluster's config server type for optimal performance and savings.
When configured as FIXED_TO_DEDICATED, the cluster will always use a dedicated config server.
Values are
ATLAS_MANAGED
orFIXED_TO_DEDICATED
. Default value isATLAS_MANAGED
.MongoDB Sharded Cluster Config Servers -
Describes a sharded cluster's config server type.
Values are
DEDICATED
orEMBEDDED
.MongoDB Sharded Cluster Config Servers -
Collection of Uniform Resource Locators that point to the MongoDB database.
Connection string URI format Hide connectionStrings attributes Show connectionStrings attributes object
-
Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related
mongodb://
connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.Network Peering Connection Hide awsPrivateLink attribute Show awsPrivateLink attribute object
-
Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related
mongodb://
connection string that you use to connect to MongoDB Cloud through the interface endpoint that the key names.Network Peering Connection
-
-
Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related
mongodb://
connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string,awsPrivateLinkSrv
contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string,awsPrivateLinkSrv
contains the non-optimized connection string even if an optimized connection string is also present.Network Peering Connection Hide awsPrivateLinkSrv attribute Show awsPrivateLinkSrv attribute object
-
Private endpoint-aware connection strings that use AWS-hosted clusters with Amazon Web Services (AWS) PrivateLink. Each key identifies an Amazon Web Services (AWS) interface endpoint. Each value identifies the related
mongodb://
connection string that you use to connect to Atlas through the interface endpoint that the key names. If the cluster uses an optimized connection string,awsPrivateLinkSrv
contains the optimized connection string. If the cluster has the non-optimized (legacy) connection string,awsPrivateLinkSrv
contains the non-optimized connection string even if an optimized connection string is also present.Network Peering Connection
-
-
Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the
mongodb+srv://
protocol. The resource returns this parameter once someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (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. For Amazon Web Services (AWS) clusters, this resource returns this parameter only if you enable custom DNS.Network Peering Connection -
List of private endpoint-aware connection strings that you can use to connect to this cluster through a private endpoint. This parameter returns only if you deployed a private endpoint to all regions to which you deployed this clusters' nodes.
Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.
Hide privateEndpoint attributes Show privateEndpoint attributes object
-
Private endpoint-aware connection string that uses the
mongodb://
protocol to connect to MongoDB Cloud through a private endpoint. -
List that contains the private endpoints through which you connect to MongoDB Cloud when you use connectionStrings.privateEndpoint[n].connectionString or connectionStrings.privateEndpoint[n].srvConnectionString.
Details of a private endpoint deployed for this cluster.
Hide endpoints attributes Show endpoints attributes object
-
Private endpoint-aware connection string that uses the
mongodb+srv://
protocol to connect to MongoDB Cloud through a private endpoint. Themongodb+srv
protocol tells the driver to look up the seed list of hosts in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application supports it. If it doesn't, use connectionStrings.privateEndpoint[n].connectionString. -
Private endpoint-aware connection string optimized for sharded clusters that uses the
mongodb+srv://
protocol to connect to MongoDB Cloud through a private endpoint. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your application and Atlas cluster supports it. If it doesn't, use and consult the documentation for connectionStrings.privateEndpoint[n].srvConnectionString. -
MongoDB process type to which your application connects. Use
MONGOD
for replica sets andMONGOS
for sharded clusters.Values are
MONGOD
orMONGOS
.
-
-
Network peering connection strings for each interface Virtual Private Cloud (VPC) endpoint that you configured to connect to this cluster. This connection string uses the
mongodb+srv://
protocol. The resource returns this parameter when someone creates a network peering connection to this cluster. This protocol tells the application to look up the host seed list in the Domain Name System (DNS). This list synchronizes with the nodes in a cluster. If the connection string uses this Uniform Resource Identifier (URI) format, you don't need to append the seed list or change the Uniform Resource Identifier (URI) if the nodes change. Use this Uniform Resource Identifier (URI) format if your driver supports it. If it doesn't, useconnectionStrings.private
. For Amazon Web Services (AWS) clusters, this parameter returns only if you enable custom DNS.Network Peering Connection -
Public connection string that you can use to connect to this cluster. This connection string uses the
mongodb://
protocol.Connection String URI Format -
Public connection string that you can use to connect to this cluster. This connection string uses the
mongodb+srv://
protocol.Connection String URI Format
-
-
Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
-
Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.
This value is not configurable on M0/M2/M5 clusters.
MongoDB Cloud requires this parameter if you set replicationSpecs.
If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value.
Storage charge calculations depend 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 more storage space, consider upgrading your cluster to a higher tier.
Minimum value is
10
, maximum value is4096
. -
Disk warming mode selection.
Values are
FULLY_WARMED
orVISIBLE_EARLIER
. Default value isFULLY_WARMED
.Reduce Secondary Disk Warming Impact -
Cloud service provider that manages your customer keys to provide an additional layer of encryption at rest for the cluster. To enable customer key management for encryption at rest, the cluster replicationSpecs[n].regionConfigs[m].{type}Specs.instanceSize setting must be
M10
or higher and"backupEnabled" : false
or omitted entirely.Values are
NONE
,AWS
,AZURE
, orGCP
.Encryption at Rest using Customer Key Management -
Feature compatibility version of the cluster.
-
Feature compatibility version expiration date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
-
Set this field to configure the Sharding Management Mode when creating a new Global Cluster.
When set to false, the management mode is set to Atlas-Managed Sharding. This mode fully manages the sharding of your Global Cluster and is built to provide a seamless deployment experience.
When set to true, the management mode is set to Self-Managed Sharding. This mode leaves the management of shards in your hands and is built to provide an advanced and flexible deployment experience.
This setting cannot be changed once the cluster is deployed.
Creating a Global Cluster -
Unique 24-hexadecimal character string that identifies the project.
Format should match the following pattern:
^([a-f0-9]{24})$
. -
Unique 24-hexadecimal digit string that identifies the cluster.
Format should match the following pattern:
^([a-f0-9]{24})$
. -
Collection of key-value pairs between 1 to 255 characters in length that tag and categorize the cluster. The MongoDB Cloud console doesn't display your labels.
Cluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.
Human-readable labels applied to this MongoDB Cloud component.
Resource Tags -
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Web Linking Specification (RFC 5988) Hide links attributes Show links attributes object
-
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with
https://cloud.mongodb.com/api/atlas
. -
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with
https://cloud.mongodb.com/api/atlas
.
-
-
MongoDB employee granted access level and expiration for a cluster.
Hide mongoDBEmployeeAccessGrant attributes Show mongoDBEmployeeAccessGrant attributes object
-
Expiration date for the employee access grant. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
-
Level of access to grant to MongoDB Employees.
Values are
CLUSTER_DATABASE_LOGS
,CLUSTER_INFRASTRUCTURE
, orCLUSTER_INFRASTRUCTURE_AND_APP_SERVICES_SYNC_DATA
. -
List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.
Web Linking Specification (RFC 5988) Hide links attributes Show links attributes object
-
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with
https://cloud.mongodb.com/api/atlas
. -
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with
https://cloud.mongodb.com/api/atlas
.
-
-
-
MongoDB major version of the cluster.
On creation: Choose from the available versions of MongoDB, or leave unspecified for the current recommended default in the MongoDB Cloud platform. The recommended version is a recent Long Term Support version. The default is not guaranteed to be the most recently released version throughout the entire release cycle. For versions available in a specific project, see the linked documentation or use the API endpoint for project LTS versions endpoint.
On update: Increase version only by 1 major version at a time. If the cluster is pinned to a MongoDB feature compatibility version exactly one major version below the current MongoDB version, the MongoDB version can be downgraded to the previous major version.
Available MongoDB Versions in Atlas -
Version of MongoDB that the cluster runs.
Format should match the following pattern:
([\d]+\.[\d]+\.[\d]+)
. -
Base connection string that you can use to connect to the cluster. MongoDB Cloud displays the string only after the cluster starts, not while it builds the cluster.
Connection string URI format -
Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.
-
Connection string that you can use to connect to the cluster including the
replicaSet
,ssl
, andauthSource
query parameters with values appropriate for the cluster. You may need to add MongoDB database users. The response returns this parameter once the cluster can receive requests, not while it builds the cluster.Connection string URI format -
Human-readable label that identifies the cluster.
Format should match the following pattern:
^[a-zA-Z0-9][a-zA-Z0-9-]*$
. -
Number of shards up to 50 to deploy for a sharded cluster. The resource returns
1
to indicate a replica set and values of2
and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.Minimum value is
1
, maximum value is50
. Default value is1
.Sharding -
Flag that indicates whether the cluster is paused.
-
Flag that indicates whether the cluster uses continuous cloud backups.
Continuous Cloud Backups -
Flag that indicates whether the M10 or higher cluster can perform Cloud Backups. If set to
true
, the cluster can perform backups. If this and backupEnabled are set tofalse
, the cluster doesn't use MongoDB Cloud backups. providerSettings
object One of: Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Range of instance sizes to which your cluster can scale.
Hide autoScaling attribute Show autoScaling attribute object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
Hide compute attributes Show compute attributes object
-
Maximum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M100
,M140
,M200
,M300
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,R700
,M40_NVME
,M50_NVME
,M60_NVME
,M80_NVME
,M200_NVME
, orM400_NVME
. -
Minimum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M100
,M140
,M200
,M300
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,R700
,M40_NVME
,M50_NVME
,M60_NVME
,M80_NVME
,M200_NVME
, orM400_NVME
.
-
-
-
Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform.
-
Flag that indicates whether the Amazon Elastic Block Store (EBS) encryption feature encrypts the host's root volume for both data at rest within the volume and for data moving between the volume and the cluster. Clusters always have this setting enabled.
Default value is
true
. -
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M100
,M140
,M200
,M300
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,R700
,M40_NVME
,M50_NVME
,M60_NVME
,M80_NVME
,M200_NVME
, orM400_NVME
. -
Physical location where MongoDB Cloud deploys your AWS-hosted MongoDB cluster nodes. The region you choose can affect network latency for clients accessing your databases. When MongoDB Cloud deploys a dedicated cluster, it checks if a VPC or VPC connection exists for that provider and region. If not, MongoDB Cloud creates them as part of the deployment. MongoDB Cloud 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.
Values are
US_GOV_WEST_1
,US_GOV_EAST_1
,US_EAST_1
,US_EAST_2
,US_WEST_1
,US_WEST_2
,CA_CENTRAL_1
,EU_NORTH_1
,EU_WEST_1
,EU_WEST_2
,EU_WEST_3
,EU_CENTRAL_1
,EU_CENTRAL_2
,AP_EAST_1
,AP_NORTHEAST_1
,AP_NORTHEAST_2
,AP_NORTHEAST_3
,AP_SOUTHEAST_1
,AP_SOUTHEAST_2
,AP_SOUTHEAST_3
,AP_SOUTHEAST_4
,AP_SOUTH_1
,AP_SOUTH_2
,SA_EAST_1
,CN_NORTH_1
,CN_NORTHWEST_1
,ME_SOUTH_1
,ME_CENTRAL_1
,AF_SOUTH_1
,EU_SOUTH_1
,EU_SOUTH_2
,IL_CENTRAL_1
,CA_WEST_1
,AP_SOUTHEAST_5
,AP_SOUTHEAST_7
,MX_CENTRAL_1
, orGLOBAL
.AWS -
Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for abbr title="Amazon Web Services">AWS. Specify whether Disk Input/Output Operations per Second (IOPS) must not exceed the default Input/Output Operations per Second (IOPS) rate for the selected volume size (
STANDARD
), or must fall within the allowable Input/Output Operations per Second (IOPS) range for the selected volume size (PROVISIONED
). You must set this value to (PROVISIONED
) for NVMe clusters.Values are
STANDARD
orPROVISIONED
.
Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Range of instance sizes to which your cluster can scale.
Hide autoScaling attribute Show autoScaling attribute object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
Hide compute attributes Show compute attributes object
-
Maximum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M90
,M200
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,M60_NVME
,M80_NVME
,M200_NVME
,M300_NVME
,M400_NVME
, orM600_NVME
. -
Minimum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M90
,M200
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,M60_NVME
,M80_NVME
,M200_NVME
,M300_NVME
,M400_NVME
, orM600_NVME
.
-
-
-
Disk type that corresponds to the host's root volume for Azure instances. If omitted, the default disk type for the selected providerSettings.instanceSizeName applies.
Values are
P2
,P3
,P4
,P6
,P10
,P15
,P20
,P30
,P40
, orP50
.Disk type -
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M90
,M200
,R40
,R50
,R60
,R80
,R200
,R300
,R400
,M60_NVME
,M80_NVME
,M200_NVME
,M300_NVME
,M400_NVME
, orM600_NVME
. -
Microsoft Azure Regions.
Values are
US_CENTRAL
,US_EAST
,US_EAST_2
,US_NORTH_CENTRAL
,US_WEST
,US_SOUTH_CENTRAL
,EUROPE_NORTH
,EUROPE_WEST
,US_WEST_CENTRAL
,US_WEST_2
,US_WEST_3
,CANADA_EAST
,CANADA_CENTRAL
,BRAZIL_SOUTH
,BRAZIL_SOUTHEAST
,AUSTRALIA_CENTRAL
,AUSTRALIA_CENTRAL_2
,AUSTRALIA_EAST
,AUSTRALIA_SOUTH_EAST
,GERMANY_WEST_CENTRAL
,GERMANY_NORTH
,SWEDEN_CENTRAL
,SWEDEN_SOUTH
,SWITZERLAND_NORTH
,SWITZERLAND_WEST
,UK_SOUTH
,UK_WEST
,NORWAY_EAST
,NORWAY_WEST
,INDIA_CENTRAL
,INDIA_SOUTH
,INDIA_WEST
,CHINA_EAST
,CHINA_NORTH
,ASIA_EAST
,JAPAN_EAST
,JAPAN_WEST
,ASIA_SOUTH_EAST
,KOREA_CENTRAL
,KOREA_SOUTH
,FRANCE_CENTRAL
,FRANCE_SOUTH
,SOUTH_AFRICA_NORTH
,SOUTH_AFRICA_WEST
,UAE_CENTRAL
,UAE_NORTH
, orQATAR_CENTRAL
.Azure
Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Range of instance sizes to which your cluster can scale.
Hide autoScaling attribute Show autoScaling attribute object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down. Cluster tier auto-scaling is unavailable for clusters using Low CPU or NVME storage classes.
Hide compute attributes Show compute attributes object
-
Maximum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M140
,M200
,M250
,M300
,M400
,R40
,R50
,R60
,R80
,R200
,R300
,R400
, orR600
. -
Minimum instance size to which your cluster can automatically scale.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M140
,M200
,M250
,M300
,M400
,R40
,R50
,R60
,R80
,R200
,R300
,R400
, orR600
.
-
-
-
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.
Values are
M10
,M20
,M30
,M40
,M50
,M60
,M80
,M140
,M200
,M250
,M300
,M400
,R40
,R50
,R60
,R80
,R200
,R300
,R400
, orR600
. -
Google Compute Regions.
Values are
EASTERN_US
,EASTERN_US_AW
,US_EAST_4
,US_EAST_4_AW
,US_EAST_5
,US_EAST_5_AW
,US_WEST_2
,US_WEST_2_AW
,US_WEST_3
,US_WEST_3_AW
,US_WEST_4
,US_WEST_4_AW
,US_SOUTH_1
,US_SOUTH_1_AW
,CENTRAL_US
,CENTRAL_US_AW
,WESTERN_US
,WESTERN_US_AW
,NORTH_AMERICA_NORTHEAST_1
,NORTH_AMERICA_NORTHEAST_2
,NORTH_AMERICA_SOUTH_1
,SOUTH_AMERICA_EAST_1
,SOUTH_AMERICA_WEST_1
,WESTERN_EUROPE
,EUROPE_NORTH_1
,EUROPE_WEST_2
,EUROPE_WEST_3
,EUROPE_WEST_4
,EUROPE_WEST_6
,EUROPE_WEST_8
,EUROPE_WEST_9
,EUROPE_WEST_10
,EUROPE_WEST_12
,EUROPE_SOUTHWEST_1
,EUROPE_CENTRAL_2
,MIDDLE_EAST_CENTRAL_1
,MIDDLE_EAST_CENTRAL_2
,MIDDLE_EAST_WEST_1
,AUSTRALIA_SOUTHEAST_1
,AUSTRALIA_SOUTHEAST_2
,AFRICA_SOUTH_1
,EASTERN_ASIA_PACIFIC
,NORTHEASTERN_ASIA_PACIFIC
,SOUTHEASTERN_ASIA_PACIFIC
,ASIA_EAST_2
,ASIA_NORTHEAST_2
,ASIA_NORTHEAST_3
,ASIA_SOUTH_1
,ASIA_SOUTH_2
, orASIA_SOUTHEAST_2
.GCP
Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Range of instance sizes to which your cluster can scale.
Hide autoScaling attribute Show autoScaling attribute object
-
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.
-
-
Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when providerSettings.providerName is
TENANT
and providerSetting.instanceSizeName isM0
,M2
orM5
.Please note that using an instanceSize of M2 or M5 will create a Flex cluster instead. Support for the instanceSize of M2 or M5 will be discontinued in January 2026. We recommend using the createFlexCluster API for such configurations moving forward.
Values are
AWS
,GCP
, orAZURE
.createFlexCluster API -
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set providerSettings.providerName to
TENANT
and specify the cloud service provider in providerSettings.backingProviderName.Values are
M0
,M2
, orM5
.
Group of cloud provider settings that configure the provisioned MongoDB hosts.
Hide attributes Show attributes
-
Value is
Cloud Service Provider Settings for a Cluster
. -
Cloud service provider on which MongoDB Cloud provisioned the multi-tenant host. The resource returns this parameter when providerSettings.providerName is
FLEX
and providerSetting.instanceSizeName isFLEX
.Values are
AWS
,GCP
, orAZURE
. -
Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster. You must set providerSettings.providerName to
FLEX
and specify the cloud service provider in providerSettings.backingProviderName.Value is
FLEX
.
-
-
Set this field to configure the replica set scaling mode for your cluster.
By default, Atlas scales under WORKLOAD_TYPE. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.
When configured as SEQUENTIAL, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.
When configured as NODE_TYPE, Atlas scales your electable nodes in parallel with your read-only and analytics nodes. This mode is intended for large, dynamic workloads requiring frequent and timely cluster tier scaling. This is the fastest scaling strategy, but it might impact latency of workloads when performing extensive secondary reads.
Values are
SEQUENTIAL
,WORKLOAD_TYPE
, orNODE_TYPE
. Default value isWORKLOAD_TYPE
.Modify the Replica Set Scaling Mode -
Number of members that belong to the replica set. Each member retains a copy of your databases, providing high availability and data redundancy. Use replicationSpecs instead.
Values are
3
,5
, or7
. Default value is3
. -
Physical location where MongoDB Cloud provisions cluster nodes.
Hide replicationSpec attribute Show replicationSpec attribute object
-
Physical location where MongoDB Cloud provisions cluster nodes.
Hide * attributes Show * attributes object
-
Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use replicationSpecs[n].{region}.analyticsNodes instead.
-
Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use replicationSpecs[n].{region}.electableNodes instead.
Values are
0
,3
,5
, or7
. -
Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to
7
. The primary node runs in the Preferred Region. To identify a read-only region, set this parameter to0
.Minimum value is
0
, maximum value is7
. -
Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use replicationSpecs[n].{region}.readOnlyNodes instead.
-
-
-
List of settings that configure your cluster regions.
- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.
- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.
Hide replicationSpecs attributes Show replicationSpecs attributes object
-
Unique 24-hexadecimal digit string that identifies the replication object for a zone in a Global Cluster.
If you include existing zones in the request, you must specify this parameter.
If you add a new zone to an existing Global Cluster, you may specify this parameter. The request deletes any existing zones in a Global Cluster that you exclude from the request.
Format should match the following pattern:
^([a-f0-9]{24})$
. -
Positive integer that specifies the number of shards to deploy in each specified zone If you set this value to
1
and clusterType isSHARDED
, MongoDB Cloud 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.If you are upgrading a replica set to a sharded cluster, you cannot increase the number of shards in the same update request. You should wait until after the cluster has completed upgrading to sharded and you have reconnected all application clients to the MongoDB router before adding additional shards. Otherwise, your data might become inconsistent once MongoDB Cloud begins distributing data across shards.
Default value is
1
. -
Physical location where MongoDB Cloud provisions cluster nodes.
Hide regionsConfig attribute Show regionsConfig attribute object
-
Physical location where MongoDB Cloud provisions cluster nodes.
Hide * attributes Show * attributes object
-
Number of analytics nodes in the region. Analytics nodes handle analytic data such as reporting queries from MongoDB Connector for Business Intelligence on MongoDB Cloud. Analytics nodes are read-only, and can never become the primary. Use replicationSpecs[n].{region}.analyticsNodes instead.
-
Number of electable nodes to deploy in the specified region. Electable nodes can become the primary and can facilitate local reads. Use replicationSpecs[n].{region}.electableNodes instead.
Values are
0
,3
,5
, or7
. -
Number that indicates the election priority of the region. To identify the Preferred Region of the cluster, set this parameter to
7
. The primary node runs in the Preferred Region. To identify a read-only region, set this parameter to0
.Minimum value is
0
, maximum value is7
. -
Number of read-only nodes in the region. Read-only nodes can never become the primary member, but can facilitate local reads. Use replicationSpecs[n].{region}.readOnlyNodes instead.
-
-
-
Human-readable label that identifies the zone in a Global Cluster. Provide this value only if clusterType is
GEOSHARDED
.
-
Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group.
Value is
ISRGROOTX1
. Default value isISRGROOTX1
. -
Connection string that you can use to connect to the cluster. The
+srv
modifier forces the connection to use Transport Layer Security (TLS). ThemongoURI
parameter lists additional options.Connection string URI format -
Human-readable label that indicates the current operating condition of the cluster.
Values are
IDLE
,CREATING
,UPDATING
,DELETING
, orREPAIRING
. -
List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.
Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example,
environment : production
.Resource Tags Hide tags attributes Show tags attributes object
-
Constant that defines the set of the tag. For example,
environment
in theenvironment : production
tag.Minimum length is
1
, maximum length is255
. -
Variable that belongs to the set of the tag. For example,
production
in theenvironment : production
tag.Minimum length is
1
, maximum length is255
.
-
-
Flag that indicates whether termination protection is enabled on the cluster. If set to
true
, MongoDB Cloud won't delete the cluster. If set tofalse
, MongoDB Cloud will delete the cluster.Default value is
false
. -
Method by which the cluster maintains the MongoDB versions. If value is
CONTINUOUS
, you must not specify mongoDBMajorVersion.Values are
LTS
orCONTINUOUS
. Default value isLTS
.
-
-
Bad Request.
Hide response attributes Show response attributes object
-
Bad request detail.
Hide badRequestDetail attribute Show badRequestDetail attribute object
-
Describes the specific conditions or reasons that cause each type of error.
-
HTTP status code returned with this error.
External documentation -
Application error code returned with this error.
-
Parameters used to give more information about the error.
-
Application error message returned with this error.
-
-
Unauthorized.
Hide response attributes Show response attributes object
-
Bad request detail.
Hide badRequestDetail attribute Show badRequestDetail attribute object
-
Describes the specific conditions or reasons that cause each type of error.
-
HTTP status code returned with this error.
External documentation -
Application error code returned with this error.
-
Parameters used to give more information about the error.
-
Application error message returned with this error.
-
-
Payment Required.
Hide response attributes Show response attributes object
-
Bad request detail.
Hide badRequestDetail attribute Show badRequestDetail attribute object
-
Describes the specific conditions or reasons that cause each type of error.
-
HTTP status code returned with this error.
External documentation -
Application error code returned with this error.
-
Parameters used to give more information about the error.
-
Application error message returned with this error.
-
-
Forbidden.
Hide response attributes Show response attributes object
-
Bad request detail.
Hide badRequestDetail attribute Show badRequestDetail attribute object
-
Describes the specific conditions or reasons that cause each type of error.
-
HTTP status code returned with this error.
External documentation -
Application error code returned with this error.
-
Parameters used to give more information about the error.
-
Application error message returned with this error.
-
-
Not Found.
Hide response attributes Show response attributes object
-
Bad request detail.
Hide badRequestDetail attribute Show badRequestDetail attribute object
-
Describes the specific conditions or reasons that cause each type of error.
-
HTTP status code returned with this error.
External documentation -
Application error code returned with this error.
-
Parameters used to give more information about the error.
-
Application error message returned with this error.
-
-
Conflict.
Hide response attributes Show response attributes object
-
Bad request detail.
Hide badRequestDetail attribute Show badRequestDetail attribute object
-
Describes the specific conditions or reasons that cause each type of error.
-
HTTP status code returned with this error.
External documentation -
Application error code returned with this error.
-
Parameters used to give more information about the error.
-
Application error message returned with this error.
-
-
Internal Server Error.
Hide response attributes Show response attributes object
-
Bad request detail.
Hide badRequestDetail attribute Show badRequestDetail attribute object
-
Describes the specific conditions or reasons that cause each type of error.
-
HTTP status code returned with this error.
External documentation -
Application error code returned with this error.
-
Parameters used to give more information about the error.
-
Application error message returned with this error.
-
atlas api upgradeSharedCluster --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
client, err := sdk.NewClient(
sdk.UseOAuthAuth(clientID, clientSecret),
sdk.UseBaseURL(url))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpgradeSharedClusterApiParams{}
sdkResp, httpResp, err := client.ClustersApi.
UpgradeSharedClusterWithParams(ctx, params).
Execute()
}
curl --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade" \
-d '{ <Payload> }'
{
"acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"predictiveEnabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"globalClusterSelfManagedSharding": true,
"labels": [
{
"key": "string",
"value": "string"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2025-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS"
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "Cloud Service Provider Settings for a Cluster",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
{
"acceptDataRisksAndForceReplicaSetReconfig": "2025-05-04T09:42:00Z",
"advancedConfiguration": {
"customOpensslCipherConfigTls12": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
],
"minimumEnabledTlsProtocol": "TLS1_0",
"tlsCipherConfigMode": "CUSTOM"
},
"autoScaling": {
"compute": {
"enabled": false,
"predictiveEnabled": false,
"scaleDownEnabled": false
},
"diskGBEnabled": false
},
"backupEnabled": true,
"biConnector": {
"enabled": true,
"readPreference": "PRIMARY"
},
"clusterType": "REPLICASET",
"configServerManagementMode": "ATLAS_MANAGED",
"configServerType": "DEDICATED",
"connectionStrings": {
"awsPrivateLink": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"awsPrivateLinkSrv": {
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"private": "string",
"privateEndpoint": [
{
"connectionString": "string",
"endpoints": [
{
"endpointId": "string",
"providerName": "AWS",
"region": "string"
}
],
"srvConnectionString": "string",
"srvShardOptimizedConnectionString": "string",
"type": "MONGOD"
}
],
"privateSrv": "string",
"standard": "string",
"standardSrv": "string"
},
"createDate": "2025-05-04T09:42:00Z",
"diskSizeGB": 42.0,
"diskWarmingMode": "FULLY_WARMED",
"encryptionAtRestProvider": "NONE",
"featureCompatibilityVersion": "string",
"featureCompatibilityVersionExpirationDate": "2025-05-04T09:42:00Z",
"globalClusterSelfManagedSharding": true,
"groupId": "32b6e34b3d91647abb20e7b8",
"id": "32b6e34b3d91647abb20e7b8",
"labels": [
{
"key": "string",
"value": "string"
}
],
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"mongoDBEmployeeAccessGrant": {
"expirationTime": "2025-05-04T09:42:00Z",
"grantType": "CLUSTER_DATABASE_LOGS",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
]
},
"mongoDBMajorVersion": "5.0",
"mongoDBVersion": "5.0.25",
"mongoURI": "string",
"mongoURIUpdated": "2025-05-04T09:42:00Z",
"mongoURIWithOptions": "string",
"name": "string",
"numShards": 1,
"paused": true,
"pitEnabled": true,
"providerBackupEnabled": true,
"providerSettings": {
"providerName": "Cloud Service Provider Settings for a Cluster",
"autoScaling": {
"compute": {
"maxInstanceSize": "M10",
"minInstanceSize": "M10"
}
},
"diskIOPS": 42,
"encryptEBSVolume": true,
"instanceSizeName": "M10",
"regionName": "US_GOV_WEST_1",
"volumeType": "STANDARD"
},
"replicaSetScalingStrategy": "WORKLOAD_TYPE",
"replicationFactor": 3,
"replicationSpec": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"replicationSpecs": [
{
"id": "32b6e34b3d91647abb20e7b8",
"numShards": 1,
"regionsConfig": {
"additionalProperty1": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
},
"additionalProperty2": {
"analyticsNodes": 42,
"electableNodes": 0,
"priority": 42,
"readOnlyNodes": 42
}
},
"zoneName": "string"
}
],
"rootCertType": "ISRGROOTX1",
"srvAddress": "string",
"stateName": "IDLE",
"tags": [
{
"key": "string",
"value": "string"
}
],
"terminationProtectionEnabled": false,
"versionReleaseSystem": "LTS"
}
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 402,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Payment Required",
"errorCode": "NO_PAYMENT_INFORMATION_FOUND"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}