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

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.

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

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

This API exposes 35 operations across 18 paths, and defines 49 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.

35 operations 18 paths 49 schemas 7 DELETE18 GET3 PATCH6 POST1 PUT

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
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Cloud Backups 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 35

Across 18 paths, the API surfaces 35 operations — 7 DELETE, 18 GET, 3 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Cloud Backups 35

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

GET
/api/atlas/v2/groups/{groupId}/backup/exportBuckets
Return All Snapshot Export Buckets
listGroupBackupExportBuckets 6 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/backup/exportBuckets
Create One Snapshot Export Bucket
createGroupBackupExportBucket 3 params body → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}
Delete One Snapshot Export Bucket
deleteGroupBackupExportBucket 3 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}
Return One Snapshot Export Bucket
getGroupBackupExportBucket 3 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/backup/exportBuckets/{exportBucketId}
Update One Export Bucket Private Networking Settings
updateGroupBackupExportBucket 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints
Return Object Storage Private Endpoints for Cloud Backups for One Cloud Provider in One Project
listGroupBackupPrivateEndpoints 7 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints
Create One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project
createGroupBackupPrivateEndpoint 4 params body → 201400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}
Delete One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider from One Project
deleteGroupBackupPrivateEndpoint 5 params → 204401403404429500
GET
/api/atlas/v2/groups/{groupId}/backup/{cloudProvider}/privateEndpoints/{endpointId}
Return One Object Storage Private Endpoint for Cloud Backups for One Cloud Provider in One Project
getGroupBackupPrivateEndpoint 5 params → 200401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/backupCompliancePolicy
Disable Backup Compliance Policy Settings
disableGroupBackupCompliancePolicy 3 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/backupCompliancePolicy
Return Backup Compliance Policy Settings
getGroupBackupCompliancePolicy 3 params → 200401403404429500
PUT
/api/atlas/v2/groups/{groupId}/backupCompliancePolicy
Update Backup Compliance Policy Settings
updateGroupBackupCompliancePolicy 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports
Return All Snapshot Export Jobs
listGroupClusterBackupExports 7 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports
Create One Snapshot Export Job
createGroupClusterBackupExport 3 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/exports/{exportId}
Return One Snapshot Export Job
getGroupClusterBackupExport 4 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs
Return All Restore Jobs for One Cluster
listGroupClusterBackupRestoreJobs 7 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs
Create One Restore Job of One Cluster
createGroupClusterBackupRestoreJob 4 params body → 200400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}
Cancel One Restore Job for One Cluster
cancelGroupClusterBackupRestoreJob 5 params → 204400401403404405429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/restoreJobs/{restoreJobId}
Return One Restore Job for One Cluster
getGroupClusterBackupRestoreJob 5 params → 200401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule
Remove All Cloud Backup Schedules
deleteGroupClusterBackupSchedule 3 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule
Return One Cloud Backup Schedule
getGroupClusterBackupSchedule 4 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/schedule
Update Cloud Backup Schedule for One Cluster
updateGroupClusterBackupSchedule 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots
Return All Replica Set Cloud Backups
listGroupClusterBackupSnapshots 10 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots
Take One On-Demand Snapshot
takeGroupClusterBackupSnapshots 4 params body → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}
Remove One Sharded Cluster Cloud Backup
deleteGroupClusterBackupSnapshotShardedCluster 5 params → 204401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedCluster/{snapshotId}
Return One Sharded Cluster Cloud Backup
getGroupClusterBackupSnapshotShardedCluster 5 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/shardedClusters
Return All Sharded Cluster Cloud Backups
listGroupClusterBackupSnapshotShardedClusters 4 params → 200400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}
Remove One Replica Set Cloud Backup
deleteGroupClusterBackupSnapshot 5 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}
Return One Replica Set Cloud Backup
getGroupClusterBackupSnapshot 5 params → 200400401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backup/snapshots/{snapshotId}
Update Expiration Date for One Cloud Backup
updateGroupClusterBackupSnapshot 5 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobsdeprecated
Return All Restore Jobs for One Serverless Instance
listGroupServerlessBackupRestoreJobs 7 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobsdeprecated
Create One Restore Job for One Serverless Instance
createGroupServerlessBackupRestoreJob 4 params body → 200400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/restoreJobs/{restoreJobId}deprecated
Return One Restore Job for One Serverless Instance
getGroupServerlessBackupRestoreJob 5 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshotsdeprecated
Return All Snapshots of One Serverless Instance
listGroupServerlessBackupSnapshots 7 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/serverless/{clusterName}/backup/snapshots/{snapshotId}deprecated
Return One Snapshot of One Serverless Instance
getGroupServerlessBackupSnapshot 4 params → 200400401403404429500

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are DiskBackupSnapshotSchedule20240805 (20 properties), DiskBackupSnapshotRestoreJob (19 properties), ServerlessBackupRestoreJob (17 properties), DiskBackupShardedClusterSnapshot (16 properties). Each schema is shown below with its type and property counts.

DiskBackupCopyPolicyItem
object
Specifications for one copy policy item.
2 properties 1 required
PaginatedBackupSnapshotExportBucketsView
object
3 properties 1 required
DiskBackupShardedClusterSnapshotMember
object
3 properties 3 required
DiskBackupCopySetting20240805
object
Copy setting item in the desired backup policy.
7 properties 1 required
ApiError
object
6 properties 2 required
Link
object
2 properties
ExportStatus
object
State of the Export Job.
2 properties
DiskBackupSnapshotRestoreJob
object
19 properties 1 required
DiskBackupExportMember
object
2 properties
BackupLabel
object
Collection of key-value pairs that represent custom data to add to the metadata file that MongoDB Cloud uploads to the bucket when the export job finishes.
2 properties
BackupComplianceScheduledPolicyItem
object
Specifications for scheduled policy.
5 properties 4 required
FieldViolation
object
2 properties 2 required
DiskBackupOnDemandSnapshotRequest
object
3 properties
DiskBackupTimeBasedCopyPolicyItem
object
Specifications for one time-based copy policy item.
3 required
DiskBackupExportJob
object
12 properties 1 required
PaginatedCloudBackupRestoreJobView
object
3 properties 1 required
ObjectStoragePrivateEndpointResponse
object
6 properties
DiskBackupSnapshot
object
13 properties
DataProtectionSettings20231001
object
14 properties 3 required
PaginatedApiAtlasServerlessBackupSnapshotView
object
3 properties 1 required
DiskBackupApiPolicyItem
object
Specifications for one policy.
5 properties 4 required
DiskBackupOnDemandCopyPolicyItem
object
Specifications for one on-demand copy policy item.
1 required
AutoExportPolicyView
object
Policy for automatically exporting Cloud Backup Snapshots.
2 properties
ApiBSONTimestampView
object
BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
2 properties
PaginatedCloudBackupReplicaSetView
object
3 properties 1 required
DiskBackupExportJobRequest
object
4 properties 2 required
BackupSnapshotRetention
object
3 properties 2 required
ExtraRetentionSetting
object
Extra retention setting item in the desired backup policy.
2 properties
DiskBackupSnapshotAWSExportBucketResponse
object
7 properties 4 required
PaginatedCloudBackupShardedClusterSnapshotView
object
3 properties 1 required
ApiPrivateDownloadDeliveryUrl
object
One Uniform Resource Locator (URL) that points to the compressed snapshot files for manual download and the corresponding private endpoint.
2 properties
AdvancedDiskBackupSnapshotSchedulePolicy
object
List that contains a document for each backup policy item in the desired backup policy.
2 properties 1 required
StateReason
object
State reason of the Job. This is set when the job state is "Failed".
2 properties
PaginatedApiAtlasObjectStoragePrivateEndpointResponseView
object
3 properties 1 required
ServerlessBackupRestoreJob
object
17 properties 3 required
DiskBackupShardedClusterSnapshot
object
Details of the sharded cluster snapshot that MongoDB Cloud created.
16 properties
DeleteCopiedBackups20240805
object
Deleted copy setting whose backup copies need to also be deleted.
3 properties
PaginatedApiAtlasServerlessBackupRestoreJobView
object
3 properties 1 required
ObjectStoragePrivateEndpointRequest
object
2 properties
PaginatedApiAtlasDiskBackupExportJobView
object
3 properties 1 required
UpdateRequirePrivateNetworkingRequestView
object
Request body to toggle the private-networking requirement for an existing export bucket.
1 property 1 required
DiskBackupSnapshotExportBucketResponse
object
Disk backup snapshot Export Bucket.
4 properties 3 required
DiskBackupSnapshotExportBucketRequest
object
Disk backup snapshot Export Bucket Request.
2 properties 1 required
BadRequestDetail
object
Bad request detail.
1 property
DiskBackupSnapshotSchedule20240805
object
20 properties 1 required
BackupComplianceOnDemandPolicyItem
object
Specifications for on-demand policy.
5 properties 4 required
ServerlessBackupSnapshot
object
10 properties
DiskBackupReplicaSet
object
Details of the replica set snapshot that MongoDB Cloud created.
16 properties
DiskBackupRestoreMember
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-cloud-backups-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
MongoDB Cluster Outage Simulation API
Where this information came from

This is an independent, third-party profile of MongoDB Cloud Backups 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.