MongoDB

MongoDB Cloud Backups API

Manages Cloud Backup snapshots, snapshot export buckets, restore jobs, and schedules. This resource applies only to clusters that use Cloud Backups.

GitHub OpenAPI
Business capability
Disaster Recovery & Resilience BC-4220.60

Operations 44

GET /api/atlas/v2/groups/{groupId}/backup/exportBuckets Return All Snapshot Export Buckets #
POST /api/atlas/v2/groups/{groupId}/backup/exportBuckets Create One Snapshot Export Bucket #
DELETE /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} Delete One Snapshot Export Bucket #
GET /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} Return One Snapshot Export Bucket #
PATCH /api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId} Update One Export Bucket Private Networking Settings #
GET /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints Return Object Storage Private Endpoints for Cloud Backups for One Cloud… #
POST /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints Create One Object Storage Private Endpoint for Cloud Backups for One Cloud… #
DELETE /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId} Delete One Object Storage Private Endpoint for Cloud Backups for One Cloud… #
GET /api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId} Return One Object Storage Private Endpoint for Cloud Backups for One Cloud… #
DELETE /api/atlas/v2/groups/{groupId}/backupCompliancePolicy Disable Backup Compliance Policy Settings #
GET /api/atlas/v2/groups/{groupId}/backupCompliancePolicy Return Backup Compliance Policy Settings #
PUT /api/atlas/v2/groups/{groupId}/backupCompliancePolicy Update Backup Compliance Policy Settings #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports Return All Snapshot Export Jobs #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports Create One Snapshot Export Job #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId} Return One Snapshot Export Job #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs Return All Restore Jobs for One Cluster #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs Create One Restore Job of One Cluster #
DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId} Cancel One Restore Job for One Cluster #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId} Return One Restore Job for One Cluster #
DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule Remove All Cloud Backup Schedules #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule Return One Cloud Backup Schedule #
PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule Update Cloud Backup Schedule for One Cluster #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots Return All Replica Set Cloud Backups #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots Take One On-Demand Snapshot #
DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId} Remove One Sharded Cluster Cloud Backup #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId} Return One Sharded Cluster Cloud Backup #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters Return All Sharded Cluster Cloud Backups #
DELETE /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} Remove One Replica Set Cloud Backup #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} Return One Replica Set Cloud Backup #
PATCH /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId} Update Expiration Date for One Cloud Backup #
GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs Return All Restore Jobs for One Serverless Instance #
POST /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs Create One Restore Job for One Serverless Instance #
GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId} Return One Restore Job for One Serverless Instance #
GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots Return All Snapshots of One Serverless Instance #
GET /api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId} Return One Snapshot of One Serverless Instance #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}/databases Return Databases in One Snapshot #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}/databases/{databaseName} Return One Database in One Snapshot #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}/databases/{databaseName}/collections Return Collections in One Database in One Snapshot #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}/databases/{databaseName}/collections/{collectionName} Return One Collection in One Database in One Snapshot #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collectionRestoreJobs Return All Collection Restore Jobs for One Cluster #
POST /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collectionRestoreJobs Create One Collection Restore Job #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collectionRestoreJobs/{jobId} Return One Collection Restore Job for One Cluster #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collectionRestoreJobs/{jobId}/collections Return All Collection States for One Collection Restore Job #
GET /api/atlas/v2/groups/{groupId}/clusters/{clusterName}/collectionRestoreJobs/{jobId}/collections/{sourceNamespace} Return One Collection State for One Collection Restore Job #

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-cloud-backups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-disk-backup-snapshot-restore-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-disk-backup-snapshot-schedule20240805-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-disk-backup-sharded-cluster-snapshot-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-serverless-backup-restore-job-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-data-protection-settings20231001-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/json-schema/mongodb-disk-backup-replica-set-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-cloud-backups-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-cloud-backups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Mongodb Cloud Backups 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 Cloud Backups 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 (298 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mongodb/refs/heads/main/openapi/mongodb-cloud-backups-api-openapi.yml