How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
MongoDB

MongoDB Clusters API

Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.

Documentation Provider Profile APIs.io OpenAPI GitHub

MongoDB Clusters API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 20 operations across 16 paths, and defines 68 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

20 operations 16 paths 68 schemas 1 DELETE8 GET2 PATCH9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
License
CC BY-NC-SA 3.0 US
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

MongoDB Clusters API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 20

Across 16 paths, the API surfaces 20 operations — 1 DELETE, 8 GET, 2 PATCH, 9 POST. Each is listed below with its method, path, parameters, and response codes.

Clusters 20

Returns, adds, edits, and removes database deployments. Changes to cluster configurations can affect costs. This resource requires your Project ID.

GET
/api/atlas/v2/clusters
Return All Authorized Clusters in All Projects
listClusterDetails 5 params → 200401403429500
GET
/api/atlas/v2/groups/{groupId}/clusters
Return All Clusters in One Project
listGroupClusters 8 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters
Create One Cluster in One Project
createGroupCluster 5 params body → 201400401402403404409429
GET
/api/atlas/v2/groups/{groupId}/clusters/provider/regions
Return All Cloud Provider Regions
listGroupClusterProviderRegions 8 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade
Upgrade One Shared-Tier Cluster
upgradeGroupClusterTenantUpgrade 3 params body → 200400401402403404409429
POST
/api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerlessdeprecated
Upgrade One Shared-Tier Cluster to One Serverless Instance
upgradeGroupClusterTenantUpgradeToServerless 3 params body → 200400401402403404409429
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}
Remove One Cluster from One Project
deleteGroupCluster 5 params → 202400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}
Return One Cluster from One Project
getGroupCluster 6 params → 200401403404409429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}
Update One Cluster in One Project
updateGroupCluster 6 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfigurationdeprecated
Return Auto Scaling Configuration for One Sharded Cluster
autoGroupClusterScalingConfiguration 4 params → 200401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs
Return Advanced Configuration Options for One Cluster
getGroupClusterProcessArgs 4 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs
Update Advanced Configuration Options for One Cluster
updateGroupClusterProcessArgs 4 params body → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries
Test Failover for One Cluster
restartGroupClusterPrimaries 4 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status
Return Status of All Cluster Operations
getGroupClusterStatus 4 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess
Grant MongoDB Employee Cluster Access for One Cluster
grantGroupClusterMongoDbEmployeeAccess 4 params body → 204400401403404409429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion
Pin Feature Compatibility Version for One Cluster in One Project
pinGroupClusterFeatureCompatibilityVersion 4 params body → 204400401403404409429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess
Revoke MongoDB Employee Cluster Access for One Cluster
revokeGroupClusterMongoDbEmployeeAccess 4 params → 204400401403404409429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion
Unpin Feature Compatibility Version for One Cluster in One Project
unpinGroupClusterFeatureCompatibilityVersion 4 params → 204400401402403404409429
POST
/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name}
Load Sample Dataset into One Cluster
requestGroupSampleDatasetLoad 3 params → 201400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId}
Return Status of Sample Dataset Load for One Cluster
getGroupSampleDatasetLoad 3 params → 200401403404429500

Schemas 68

The contract defines 68 schemas that model the data the API accepts and returns. The most detailed are LegacyAtlasCluster (44 properties), LegacyAtlasTenantClusterUpgradeRequest (44 properties), ClusterDescription20240805 (36 properties), ClusterDescriptionProcessArgs20240805 (16 properties). Each schema is shown below with its type and property counts.

ClusterFlexProviderSettings
object
AWSRegionConfig20240805
object
Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.
ClusterFreeProviderSettings
object
ClusterDescriptionAutoScalingModeConfiguration
object
Contains the internal configuration of AutoScaling on sharded clusters.
1 property
ClusterAutoScalingSettings
object
Range of instance sizes to which your cluster can scale.
2 properties
AzureRegionConfig20240805
object
Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.
LegacyAtlasCluster
object
Group of settings that configure a MongoDB cluster.
44 properties
TenantRegionConfig20240805
object
Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.
AWSCloudProviderSettings
object
CloudProviderRegions
object
2 properties
FieldViolation
object
2 properties 2 required
ResourceTag
object
Key-value pair that tags and categorizes a MongoDB Cloud organization, project, or cluster. For example, environment : production.
2 properties 2 required
PaginatedApiAtlasProviderRegionsView
object
3 properties 1 required
SampleDatasetStatus
object
6 properties
BiConnector
object
Settings needed to configure the MongoDB Connector for Business Intelligence for this cluster.
2 properties
ClusterComputeAutoScaling
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 unavaila…
2 properties
LegacyReplicationSpec
object
4 properties
ClusterCloudProviderInstanceSize
object
2 properties
ServerlessInstanceDescription
object
Group of settings that configure a MongoDB serverless instance.
12 properties 1 required
AWSComputeAutoScaling
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 unavaila…
2 properties
CloudProviderGCPAutoScaling
object
Range of instance sizes to which your cluster can scale.
1 property
AdvancedAutoScalingSettings
object
Options that determine how this cluster handles resource scaling.
2 properties
CloudGCPProviderSettings
object
ApiError
object
6 properties 2 required
DedicatedHardwareSpec20240805
object
The current hardware specifications for read only nodes in the region.
2 properties
GCPComputeAutoScaling
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 unavaila…
2 properties
CloudProviderAzureAutoScaling
object
Range of instance sizes to which your cluster can scale.
1 property
BaseCloudProviderInstanceSize
object
Instance size boundary to which your cluster can automatically scale.
ClusterProviderSettings
object
Group of cloud provider settings that configure the provisioned MongoDB hosts.
1 property 1 required
ApiAtlasClusterAdvancedConfigurationView
object
Group of settings that configures a subset of the advanced configuration details.
4 properties
ServerlessProviderSettings
object
Group of cloud provider settings that configure the provisioned MongoDB serverless instance.
6 properties 2 required
OrgGroup
object
7 properties
PaginatedClusterDescription20240805
object
3 properties 1 required
ServerlessConnectionStringsPrivateEndpointItem
object
Details of a private endpoint deployed for this serverless instance.
3 properties
GCPHardwareSpec20240805
object
3 properties
ClusterDescriptionConnectionStringsPrivateEndpoint
object
Private endpoint-aware connection string that you can use to connect to this cluster through a private endpoint.
5 properties
RegionSpec
object
Physical location where MongoDB Cloud provisions cluster nodes.
4 properties
ServerlessInstanceDescriptionConnectionStrings
object
Collection of Uniform Resource Locators that point to the MongoDB database.
2 properties
GCPRegionConfig20240805
object
Details that explain how MongoDB Cloud replicates data in one region on the specified MongoDB database.
ServerlessConnectionStringsPrivateEndpointList
object
Private endpoint connection string that you can use to connect to this serverless instance through a private endpoint.
3 properties
ComponentLabel
object
Human-readable labels applied to this MongoDB Cloud component.
2 properties
CloudRegionConfig20240805
object
Cloud service provider on which MongoDB Cloud provisions the hosts.
4 properties
AzureCloudProviderSettings
object
Link
object
2 properties
CloudProviderAWSAutoScaling
object
Range of instance sizes to which your cluster can scale.
1 property
ClusterStatus
object
2 properties
DiskGBAutoScaling
object
Setting that enables disk auto-scaling.
1 property
HardwareSpec20240805
object
Hardware specifications for all electable nodes deployed in the region. Electable nodes can become the primary and can enable local reads. If you don't specify…
1 property
LegacyAtlasTenantClusterUpgradeRequest
object
Request containing target state of tenant cluster to be upgraded.
44 properties 1 required
CloudCluster
object
Settings that describe the clusters in each project that the API key is authorized to view.
11 properties
ClusterServerlessBackupOptions
object
Group of settings that configure serverless backup.
1 property
BadRequestDetail
object
Bad request detail.
1 property
AvailableCloudProviderRegion
object
2 properties
ClusterDescriptionConnectionStringsPrivateEndpointEndpoint
object
Details of a private endpoint deployed for this cluster.
3 properties
ClusterDescription20240805
object
36 properties
AWSHardwareSpec20240805
object
Hardware specifications for nodes deployed in the region.
5 properties
ClusterFreeAutoScaling
object
Range of instance sizes to which your cluster can scale.
1 property
AzureComputeAutoScalingRules
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 unavaila…
2 properties
ClusterConnectionStrings
object
Collection of Uniform Resource Locators that point to the MongoDB database.
7 properties
ReplicationSpec20240805
object
Details that explain how MongoDB Cloud replicates data on the specified MongoDB database.
4 properties
PaginatedOrgGroupView
object
3 properties 1 required
FreeComputeAutoScalingRules
object
Collection of settings that configures how a cluster might scale its cluster tier and whether the cluster can scale down.
2 properties
AdvancedComputeAutoScaling
object
Options that determine how this cluster handles CPU scaling.
4 properties
TenantHardwareSpec20240805
object
3 properties
PinFCVView
object
2 properties
EmployeeAccessGrantView
object
MongoDB employee granted access level and expiration for a cluster.
3 properties 2 required
AzureHardwareSpec20240805
object
4 properties
ClusterDescriptionProcessArgs20240805
object
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-clusters-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
AE Profile APIs.io
MongoDB Atlas App Services Admin API
AE Profile APIs.io
MongoDB Access Tracking API
AE Profile APIs.io
MongoDB Activity Feed API
AE Profile APIs.io
MongoDB Alert Configurations API
AE Profile APIs.io
MongoDB Alerts API
AE Profile APIs.io
MongoDB Atlas Search API
AE Profile APIs.io
MongoDB Auditing API
AE Profile APIs.io
MongoDB AWS Clusters DNS API
AE Profile APIs.io
MongoDB Cloud Backups API
AE Profile APIs.io
MongoDB Cloud Migration Service API
AE Profile APIs.io
MongoDB Cloud Provider Access API
AE Profile APIs.io
#Cluster
← Back to M APIs
API Details
ID
mongodb:mongodb-clusters-api
Base URL
https://cloud.mongodb.com/api/atlas/v2
Docs
https://www.mongodb.com/docs/atlas/api/
Provider
MongoDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=mongodb-clusters-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/mongodb-clusters-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of MongoDB Clusters API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.