MongoDB · Schema
Tenant Cluster Upgrade Request
Request containing target state of tenant cluster to be upgraded.
Cloud DatabaseDatabaseDocument DatabaseNoSQLMongoDB
Properties
| Name | Type | Description |
|---|---|---|
| acceptDataRisksAndForceReplicaSetReconfig | string | 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 reco |
| advancedConfiguration | object | |
| autoScaling | object | |
| backupEnabled | boolean | Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedic |
| biConnector | object | |
| clusterType | string | Configuration of nodes that comprise the cluster. |
| configServerManagementMode | string | 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 an |
| configServerType | string | Describes a sharded cluster's config server type. |
| connectionStrings | object | |
| createDate | string | Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. |
| deleteAfterCreationHours | integer | Number of hours after cluster creation that this cluster will be automatically deleted. This field is used to derive `deleteAfterDate` relative to `createDate`. When set to null or zero on cluster cre |
| deleteAfterDate | string | The date at which this cluster will be automatically deleted. This parameter expresses its value in the ISO 8601 timestamp format in UTC and is derived based on the `createDate` + `deleteAfterCreation |
| diskSizeGB | number | 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 yo |
| diskWarmingMode | string | Disk warming mode selection. |
| encryptionAtRestProvider | string | 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 `repl |
| featureCompatibilityVersion | string | Feature compatibility version of the cluster. |
| featureCompatibilityVersionExpirationDate | string | Feature compatibility version expiration date. This parameter expresses its value in the ISO 8601 timestamp format in UTC. |
| globalClusterSelfManagedSharding | boolean | 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 shardi |
| groupId | string | Unique 24-hexadecimal character string that identifies the project. |
| id | string | Unique 24-hexadecimal digit string that identifies the cluster. |
| labels | array | 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 b |
| links | array | 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. |
| mongoDBEmployeeAccessGrant | object | |
| mongoDBMajorVersion | string | 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 recommende |
| mongoDBVersion | string | Version of MongoDB that the cluster runs. |
| mongoURI | string | 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. |
| mongoURIUpdated | string | Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC. |
| mongoURIWithOptions | string | Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` query parameters with values appropriate for the cluster. You may need to add MongoDB d |
| name | string | Human-readable label that identifies the cluster. |
| numShards | integer | Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the |
| paused | boolean | Flag that indicates whether the cluster is paused. |
| pitEnabled | boolean | Flag that indicates whether the cluster uses continuous cloud backups. |
| providerBackupEnabled | boolean | 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 to `false`, the cluster doesn't |
| providerSettings | object | |
| replicaSetScalingStrategy | string | 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 oper |
| replicationFactor | integer | 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. |
| replicationSpec | object | Physical location where MongoDB Cloud provisions cluster nodes. |
| replicationSpecs | array | 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 clus |
| rootCertType | string | Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group. |
| srvAddress | string | Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options. |
| stateName | string | Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available |
| tags | array | List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster. |
| terminationProtectionEnabled | boolean | Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster. |
| versionReleaseSystem | string | Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-legacy-atlas-tenant-cluster-upgrade-request-schema.json",
"title": "Tenant Cluster Upgrade Request",
"description": "Request containing target state of tenant cluster to be upgraded.",
"x-generated": "2026-10-03",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/mongodb-clusters-api-openapi.yml#/components/schemas/LegacyAtlasTenantClusterUpgradeRequest",
"properties": {
"acceptDataRisksAndForceReplicaSetReconfig": {
"description": "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.",
"format": "date-time",
"type": "string"
},
"advancedConfiguration": {
"$ref": "#/$defs/ApiAtlasClusterAdvancedConfigurationView"
},
"autoScaling": {
"$ref": "#/$defs/ClusterAutoScalingSettings"
},
"backupEnabled": {
"description": "Flag that indicates whether the cluster can perform backups. If set to `true`, the cluster can perform backups. You must set this value to `true` for NVMe clusters. Backup uses Cloud Backups for dedicated clusters and Shared Cluster Backups for tenant clusters. If set to `false`, the cluster doesn't use MongoDB Cloud backups.",
"type": "boolean"
},
"biConnector": {
"$ref": "#/$defs/BiConnector"
},
"clusterType": {
"description": "Configuration of nodes that comprise the cluster.",
"enum": [
"REPLICASET",
"SHARDED",
"GEOSHARDED"
],
"type": "string"
},
"configServerManagementMode": {
"default": "ATLAS_MANAGED",
"description": "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.",
"enum": [
"ATLAS_MANAGED",
"FIXED_TO_DEDICATED"
],
"type": "string"
},
"configServerType": {
"description": "Describes a sharded cluster's config server type.",
"enum": [
"DEDICATED",
"EMBEDDED"
],
"readOnly": true,
"type": "string"
},
"connectionStrings": {
"$ref": "#/$defs/ClusterConnectionStrings"
},
"createDate": {
"description": "Date and time when MongoDB Cloud created this serverless instance. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"deleteAfterCreationHours": {
"description": "Number of hours after cluster creation that this cluster will be automatically deleted.\n\nThis field is used to derive `deleteAfterDate` relative to `createDate`.\n\nWhen set to null or zero on cluster creation, the cluster will not be automatically deleted.\n\nWhen set to a positive value on cluster creation, the cluster will be automatically deleted after the specified number of hours.\n\nWhen updating this field on an existing (non-deleted) cluster, and this is set to null, then existing values are preserved for this & `deleteAfterDate`.\n\nWhen updating this field on an existing (non-deleted) cluster, and this is set to zero, then `deleteAfterDate` is reset to null (disable auto deletion) regardless of previous configurations.\n\nWhen updating this field on an existing (non-deleted) cluster, and this is set to a positive value, then `createDate` + `deleteAfterCreationHours` must be later than now else the field update is ignored and existing values are preserved for this & `deleteAfterDate`.",
"format": "int32",
"type": "integer"
},
"deleteAfterDate": {
"description": "The date at which this cluster will be automatically deleted.\n\nThis parameter expresses its value in the ISO 8601 timestamp format in UTC and is derived based on the `createDate` + `deleteAfterCreationHours`.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"diskSizeGB": {
"description": "Storage capacity of instance data volumes expressed in gigabytes. Increase this number to add capacity.\n\n This value is not configurable on M0/M2/M5 clusters.\n\n MongoDB Cloud requires this parameter if you set `replicationSpecs`.\n\n If you specify a disk size below the minimum (10 GB), this parameter defaults to the minimum disk size value. \n\n Storage charge calculations depend on whether you choose the default value or a custom value.\n\n 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.",
"format": "double",
"maximum": 4096,
"minimum": 10,
"type": "number"
},
"diskWarmingMode": {
"default": "FULLY_WARMED",
"description": "Disk warming mode selection.",
"enum": [
"FULLY_WARMED",
"VISIBLE_EARLIER"
],
"type": "string"
},
"encryptionAtRestProvider": {
"description": "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.",
"enum": [
"NONE",
"AWS",
"AZURE",
"GCP"
],
"type": "string"
},
"featureCompatibilityVersion": {
"description": "Feature compatibility version of the cluster.",
"readOnly": true,
"type": "string"
},
"featureCompatibilityVersionExpirationDate": {
"description": "Feature compatibility version expiration date. This parameter expresses its value in the ISO 8601 timestamp format in UTC.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"globalClusterSelfManagedSharding": {
"description": "Set this field to configure the Sharding Management Mode when creating a new Global Cluster.\n\nWhen 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.\n\nWhen 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.\n\nThis setting cannot be changed once the cluster is deployed.",
"type": "boolean"
},
"groupId": {
"description": "Unique 24-hexadecimal character string that identifies the project.",
"pattern": "^([a-f0-9]{24})$",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Unique 24-hexadecimal digit string that identifies the cluster.",
"pattern": "^([a-f0-9]{24})$",
"readOnly": true,
"type": "string"
},
"labels": {
"deprecated": true,
"description": "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.\n\nCluster labels are deprecated and will be removed in a future release. We strongly recommend that you use Resource Tags instead.",
"items": {
"$ref": "#/$defs/ComponentLabel"
},
"type": "array"
},
"links": {
"description": "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.",
"items": {
"$ref": "#/$defs/Link"
},
"readOnly": true,
"type": "array"
},
"mongoDBEmployeeAccessGrant": {
"$ref": "#/$defs/EmployeeAccessGrantView"
},
"mongoDBMajorVersion": {
"description": "MongoDB major version of the cluster.\n\nOn 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](#tag/Projects/operation/getProjectLTSVersions).\n\n 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.",
"type": "string"
},
"mongoDBVersion": {
"description": "Version of MongoDB that the cluster runs.",
"pattern": "([\\d]+\\.[\\d]+\\.[\\d]+)",
"type": "string"
},
"mongoURI": {
"description": "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.",
"readOnly": true,
"type": "string"
},
"mongoURIUpdated": {
"description": "Date and time when someone last updated the connection string. MongoDB Cloud represents this timestamp in ISO 8601 format in UTC.",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"mongoURIWithOptions": {
"description": "Connection string that you can use to connect to the cluster including the `replicaSet`, `ssl`, and `authSource` 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.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "Human-readable label that identifies the cluster.",
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$",
"type": "string"
},
"numShards": {
"default": 1,
"description": "Number of shards up to 50 to deploy for a sharded cluster. The resource returns `1` to indicate a replica set and values of `2` and higher to indicate a sharded cluster. The returned value equals the number of shards in the cluster.",
"format": "int32",
"maximum": 50,
"minimum": 1,
"type": "integer"
},
"paused": {
"description": "Flag that indicates whether the cluster is paused.",
"type": "boolean"
},
"pitEnabled": {
"description": "Flag that indicates whether the cluster uses continuous cloud backups.",
"type": "boolean"
},
"providerBackupEnabled": {
"description": "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 to `false`, the cluster doesn't use MongoDB Cloud backups.",
"type": "boolean"
},
"providerSettings": {
"$ref": "#/$defs/ClusterProviderSettings"
},
"replicaSetScalingStrategy": {
"default": "WORKLOAD_TYPE",
"description": "Set this field to configure the replica set scaling mode for your cluster.\n\nBy default, Atlas scales under `WORKLOAD_TYPE`. This mode allows Atlas to scale your analytics nodes in parallel to your operational nodes.\n\nWhen configured as `SEQUENTIAL`, Atlas scales all nodes sequentially. This mode is intended for steady-state workloads and applications performing latency-sensitive secondary reads.\n\nWhen 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.",
"enum": [
"SEQUENTIAL",
"WORKLOAD_TYPE",
"NODE_TYPE"
],
"type": "string"
},
"replicationFactor": {
"default": 3,
"deprecated": true,
"description": "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.",
"enum": [
3,
5,
7
],
"format": "int32",
"type": "integer"
},
"replicationSpec": {
"additionalProperties": {
"$ref": "#/$defs/RegionSpec"
},
"description": "Physical location where MongoDB Cloud provisions cluster nodes.",
"title": "Region Configuration",
"type": "object"
},
"replicationSpecs": {
"description": "List of settings that configure your cluster regions.\n\n- For Global Clusters, each object in the array represents one zone where MongoDB Cloud deploys your clusters nodes.\n- For non-Global sharded clusters and replica sets, the single object represents where MongoDB Cloud deploys your clusters nodes.",
"items": {
"$ref": "#/$defs/LegacyReplicationSpec"
},
"type": "array"
},
"rootCertType": {
"default": "ISRGROOTX1",
"description": "Root Certificate Authority that MongoDB Atlas cluster uses. MongoDB Cloud supports Internet Security Research Group.",
"enum": [
"ISRGROOTX1"
],
"type": "string"
},
"srvAddress": {
"description": "Connection string that you can use to connect to the cluster. The `+srv` modifier forces the connection to use Transport Layer Security (TLS). The `mongoURI` parameter lists additional options.",
"readOnly": true,
"type": "string"
},
"stateName": {
"description": "Human-readable label that indicates any current activity being taken on this cluster by the Atlas control plane. With the exception of CREATING and DELETING states, clusters should always be available and have a Primary node even when in states indicating ongoing activity.\n\n - `IDLE`: Atlas is making no changes to this cluster and all changes requested via the UI or API can be assumed to have been applied.\n - `CREATING`: A cluster being provisioned for the very first time returns state CREATING until it is ready for connections. Ensure IP Access List and DB Users are configured before attempting to connect.\n - `UPDATING`: A change requested via the UI, API, AutoScaling, or other scheduled activity is taking place.\n - `DELETING`: The cluster is in the process of deletion and will soon be deleted.\n - `REPAIRING`: One or more nodes in the cluster are being returned to service by the Atlas control plane. Other nodes should continue to provide service as normal.",
"enum": [
"IDLE",
"CREATING",
"UPDATING",
"DELETING",
"REPAIRING"
],
"readOnly": true,
"type": "string"
},
"tags": {
"description": "List that contains key-value pairs between 1 to 255 characters in length for tagging and categorizing the cluster.",
"items": {
"$ref": "#/$defs/ResourceTag"
},
"type": "array"
},
"terminationProtectionEnabled": {
"default": false,
"description": "Flag that indicates whether termination protection is enabled on the cluster. If set to `true`, MongoDB Cloud won't delete the cluster. If set to `false`, MongoDB Cloud will delete the cluster.",
"type": "boolean"
},
"versionReleaseSystem": {
"default": "LTS",
"description": "Method by which the cluster maintains the MongoDB versions. If value is `CONTINUOUS`, you must not specify `mongoDBMajorVersion`.",
"enum": [
"LTS",
"CONTINUOUS"
],
"type": "string"
}
},
"required": [
"name"
],
"type": "object",
"$defs": {
"AWSCloudProviderSettings": {
"allOf": [
{
"$ref": "#/$defs/ClusterProviderSettings"
},
{
"properties": {
"autoScaling": {
"$ref": "#/$defs/CloudProviderAWSAutoScaling"
},
"diskIOPS": {
"description": "Maximum Disk Input/Output Operations per Second (IOPS) that the database host can perform.",
"format": "int32",
"type": "integer"
},
"encryptEBSVolume": {
"default": true,
"deprecated": true,
"description": "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.",
"type": "boolean"
},
"instanceSizeName": {
"description": "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.",
"enum": [
"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",
"M400_NVME"
],
"title": "AWS Instance Sizes",
"type": "string"
},
"regionName": {
"description": "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.",
"enum": [
"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_EAST_2",
"AP_NORTHEAST_1",
"AP_NORTHEAST_2",
"AP_NORTHEAST_3",
"AP_SOUTHEAST_1",
"AP_SOUTHEAST_2",
"AP_SOUTHEAST_3",
"AP_SOUTHEAST_4",
"AP_SOUTHEAST_5",
"AP_SOUTHEAST_6",
"AP_SOUTHEAST_7",
"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",
"MX_CENTRAL_1",
"GLOBAL"
],
"title": "AWS Regions",
"type": "string"
},
"volumeType": {
"description": "Disk Input/Output Operations per Second (IOPS) setting for Amazon Web Services (AWS) storage that you configure only for 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.",
"enum": [
"STANDARD",
"PROVISIONED"
],
"type": "string"
}
},
"type": "object"
}
],
"type": "object"
},
"AWSComputeAutoScaling": {
"description": "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.",
"properties": {
"maxInstanceSize": {
"description": "Maximum instance size to which your cluster can automatically scale.",
"enum": [
"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",
"M400_NVME"
],
"title": "AWS Instance Sizes",
"type": "string"
},
"minInstanceSize": {
"description": "Minimum instance size to which your cluster can automatically scale.",
"enum": [
"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",
"M400_NVME"
],
"title": "AWS Instance Sizes",
"type": "string"
}
},
"title": "AWS",
"type": "object"
},
"ApiAtlasClusterAdvancedConfigurationView": {
"description": "Group of settings that configures a subset of the advanced configuration details.",
"properties": {
"customOpensslCipherConfigTls12": {
"description": "The custom OpenSSL cipher suite list for TLS 1.2. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.",
"items": {
"enum": [
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
],
"type": "string"
},
"type": "array"
},
"customOpensslCipherConfigTls13": {
"description": "The custom OpenSSL cipher suite list for TLS 1.3. This field is only valid when `tlsCipherConfigMode` is set to `CUSTOM`.",
"items": {
"enum": [
"TLS_AES_256_GCM_SHA384",
"TLS_CHACHA20_POLY1305_SHA256",
"TLS_AES_128_GCM_SHA256",
"TLS_AES_128_CCM_SHA256"
],
"type": "string"
},
"maxItems": 4,
"type": "array"
},
"minimumEnabledTlsProtocol": {
"description": "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.",
"enum": [
"TLS1_0",
"TLS1_1",
"TLS1_2",
"TLS1_3"
],
"type": "string"
},
"tlsCipherConfigMode": {
"description": "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.",
"enum": [
"CUSTOM",
"DEFAULT"
],
"type": "string"
}
},
"type": "object"
},
"AzureCloudProviderSettings": {
"allOf": [
{
"$ref": "#/$defs/ClusterProviderSettings"
},
{
"properties": {
"autoScaling": {
"$ref": "#/$defs/CloudProviderAzureAutoScaling"
},
"diskTypeName": {
"description": "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.",
"enum": [
"P2",
"P3",
"P4",
"P6",
"P10",
"P15",
"P20",
"P30",
"P40",
"P50"
],
"type": "string"
},
"instanceSizeName": {
"description": "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.",
"enum": [
"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",
"M600_NVME"
],
"title": "Azure Instance Sizes",
"type": "string"
},
"regionName": {
"description": "Microsoft Azure Regions.",
"enum": [
"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",
"QATAR_CENTRAL",
"POLAND_CENTRAL",
"ISRAEL_CENTRAL",
"ITALY_NORTH",
"SPAIN_CENTRAL",
"MEXICO_CENTRAL",
"NEW_ZEALAND_NORTH",
"US_GOV_VIRGINIA",
"US_GOV_ARIZONA",
"US_GOV_TEXAS"
],
"title": "Azure Regions",
"type": "string"
}
},
"type": "object"
}
],
"type": "object"
},
"AzureComputeAutoScalingRules": {
"description": "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.",
"properties": {
"maxInstanceSize": {
"description": "Maximum instance size to which your cluster can automatically scale.",
"enum": [
"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",
"M600_NVME"
],
"title": "Azure Instance Sizes",
"type": "string"
},
"minInstanceSize": {
"description": "Minimum instance size to which your cluster can automatically scale.",
"enum": [
"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",
"M600_NVME"
],
"title": "Azure Instance Sizes",
"type": "string"
}
},
"title": "Azure",
"type": "object"
},
"BiConnector": {
"description": "Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.",
"properties": {
"enabled": {
"description": "Flag that indicates whether MongoDB Connector for Business Intelligence is enabled on the specified cluster.",
"type": "boolean"
},
"readPreference": {
"description": "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, or `SECONDARY` if there are no `ANALYTICS` nodes.",
"enum": [
"PRIMARY",
"SECONDARY",
"ANALYTICS"
],
"type": "string"
}
},
"title": "MongoDB Connector for Business Intelligence Settings",
"type": "object"
},
"CloudGCPProviderSettings": {
"allOf": [
{
"$ref": "#/$defs/ClusterProviderSettings"
},
{
"properties": {
"autoScaling": {
"$ref": "#/$defs/CloudProviderGCPAutoScaling"
},
"instanceSizeName": {
"description": "Cluster tier, with a default storage and memory capacity, that applies to all the data-bearing hosts in your cluster.",
"enum": [
"M10",
"M20",
"M30",
"M40",
"M50",
"M60",
"M80",
"M140",
"M200",
"M250",
"M300",
"M400",
"R40",
"R50",
"R60",
"R80",
"R200",
"R300",
"R400",
"R600"
],
"title": "GCP Instance Sizes",
"type": "string"
},
"regionName": {
"description": "Google Compute Regions.",
"enum": [
"EASTERN_US",
"EASTERN_US_AW",
# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-legacy-atlas-tenant-cluster-upgrade-request-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/mongodb-legacy-atlas-tenant-cluster-upgrade-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.