MongoDB

MongoDB Clusters API

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

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 22

GET /api/atlas/v2/clusters Return All Authorized Clusters in All Projects #
GET /api/atlas/v2/groups/{groupId}/clusters Return All Clusters in One Project #
POST /api/atlas/v2/groups/{groupId}/clusters Create One Cluster in One Project #
GET /api/atlas/v2/groups/{groupId}/clusters/provider/regions Return All Cloud Provider Regions #
POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgrade Upgrade One Shared-Tier Cluster #
POST /api/atlas/v2/groups/{groupId}/clusters/tenantUpgradeToServerless Upgrade One Shared-Tier Cluster to One Serverless Instance #
DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName} Remove One Cluster from One Project #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName} Return One Cluster from One Project #
PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName} Update One Cluster in One Project #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/autoScalingConfiguration Return Auto Scaling Configuration for One Sharded Cluster #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs Return Advanced Configuration Options for One Cluster #
PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/processArgs Update Advanced Configuration Options for One Cluster #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restartPrimaries Test Failover for One Cluster #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/status Return Status of All Cluster Operations #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:grantMongoDBEmployeeAccess Grant MongoDB Employee Cluster Access for One Cluster #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:pinFeatureCompatibilityVersion Pin Feature Compatibility Version for One Cluster in One Project #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:revokeMongoDBEmployeeAccess Revoke MongoDB Employee Cluster Access for One Cluster #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}:unpinFeatureCompatibilityVersion Unpin Feature Compatibility Version for One Cluster in One Project #
POST /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{name} Load Sample Dataset into One Cluster #
GET /api/atlas/v2/groups/{groupId}/sampleDatasetLoad/{sampleDatasetId} Return Status of Sample Dataset Load for One Cluster #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/adaptiveSettings Return Adaptive Settings for One Cluster #
PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/adaptiveSettings Update Adaptive Settings for One Cluster #

Documentation

📖
Documentation
https://www.mongodb.com/docs/atlas/api/atlas-admin-api-ref/
📖
Authentication
https://www.mongodb.com/docs/atlas/api/api-authentication/
📖
RateLimits
https://www.mongodb.com/docs/atlas/api/api-rate-limit/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/openapi/mongodb-clusters-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-legacy-atlas-tenant-cluster-upgrade-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-legacy-atlas-cluster-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-cluster-description20240805-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-cluster-description-process-args20240805-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-serverless-instance-description-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-sample-dataset-status-schema.json

Other Resources

🔗
Versioning
https://www.mongodb.com/docs/atlas/api/versioned-api-overview/
🔗
ChangeLog
https://www.mongodb.com/docs/atlas/reference/api-resources-spec/changelog/

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/mongodb:mongodb-clusters-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

GitHub Google LinkedIn

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

OpenAPI Specification

mongodb-clusters-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mongodb Clusters API
  version: '2.0'
  license:
    name: CC BY-NC-SA 3.0 US
    url: https://creativecommons.org/licenses/by-nc-sa/3.0/us/
  termsOfService: https://www.mongodb.com/mongodb-management-service-terms-and-conditions
  x-refined-note:
  - x-xgen-sha differs across the merged source definitions and was not carried
  description: 'Operations tagged Clusters across 2 of this provider''s published API definitions: mongodb-atlas-openapi.yaml, mongodb-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://cloud.mongodb.com
security:
- ServiceAccounts: []
- DigestAuth: []
tags:


# --- truncated at 32 KB (372 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/openapi/mongodb-clusters-api-openapi.yml