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.
Operations 44
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
Schemas & Data
JSONSchema
https://artifacts.apis.io/mongodb/json-schema/mongodb-disk-backup-snapshot-restore-job-schema.json
JSONSchema
https://artifacts.apis.io/mongodb/json-schema/mongodb-disk-backup-snapshot-schedule20240805-schema.json
JSONSchema
https://artifacts.apis.io/mongodb/json-schema/mongodb-disk-backup-sharded-cluster-snapshot-schema.json
JSONSchema
https://artifacts.apis.io/mongodb/json-schema/mongodb-serverless-backup-restore-job-schema.json
JSONSchema
https://artifacts.apis.io/mongodb/json-schema/mongodb-data-protection-settings20231001-schema.json
JSONSchema
https://artifacts.apis.io/mongodb/json-schema/mongodb-disk-backup-replica-set-schema.json