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 Legacy Backup API

Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.

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

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

This API exposes 11 operations across 7 paths, and defines 16 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.

11 operations 7 paths 16 schemas 1 DELETE7 GET2 PATCH1 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
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Legacy Backup 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 11

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

Legacy Backup 11

Manages Legacy Backup snapshots, restore jobs, schedules and checkpoints.

GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpointsdeprecated
Return All Legacy Backup Checkpoints
listGroupClusterBackupCheckpoints 7 params → 200401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/backupCheckpoints/{checkpointId}deprecated
Return One Legacy Backup Checkpoint
getGroupClusterBackupCheckpoint 5 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobsdeprecated
Return All Legacy Backup Restore Jobs
listGroupClusterRestoreJobs 8 params → 200400401403404429500
POST
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobsdeprecated
Create One Legacy Backup Restore Job
createGroupClusterRestoreJob 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/restoreJobs/{jobId}deprecated
Return One Legacy Backup Restore Job
getGroupClusterRestoreJob 5 params → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotScheduledeprecated
Return One Snapshot Schedule
getGroupClusterSnapshotSchedule 4 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotScheduledeprecated
Update Snapshot Schedule for One Cluster
updateGroupClusterSnapshotSchedule 4 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshotsdeprecated
Return All Legacy Backup Snapshots
listGroupClusterSnapshots 8 params → 200401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}deprecated
Remove One Legacy Backup Snapshot
deleteGroupClusterSnapshot 5 params → 204400401403404429500
GET
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}deprecated
Return One Legacy Backup Snapshot
getGroupClusterSnapshot 5 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/clusters/{clusterName}/snapshots/{snapshotId}deprecated
Update Expiration Date for One Legacy Backup Snapshot
updateGroupClusterSnapshot 5 params body → 200401403404429500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are BackupRestoreJob (19 properties), BackupSnapshotPart (14 properties), BackupRestoreJobDelivery (12 properties), BackupSnapshot (12 properties). Each schema is shown below with its type and property counts.

BackupRestoreJobDelivery
object
Method and details that indicate how to deliver the restored snapshot data.
12 properties 1 required
ApiAtlasSnapshotScheduleView
object
10 properties 9 required
RestoreJobFileHash
object
Key and value pair that map one restore file to one hashed checksum. This parameter applies after you download the corresponding delivery.url.
4 properties
ApiCheckpointPartView
object
Metadata contained in one document that describes the complete snapshot taken for this node.
5 properties
ApiError
object
6 properties 2 required
Link
object
2 properties
PaginatedApiAtlasCheckpointView
object
3 properties 1 required
FieldViolation
object
2 properties 2 required
ApiAtlasCheckpointView
object
9 properties
ApiBSONTimestampView
object
BSON timestamp that indicates when the checkpoint token entry in the oplog occurred.
2 properties
BackupRestoreJob
object
19 properties 1 required
PaginatedSnapshotView
object
3 properties 1 required
BackupSnapshot
object
12 properties
BackupSnapshotPart
object
Characteristics that identify this snapshot.
14 properties
PaginatedRestoreJobView
object
3 properties 1 required
BadRequestDetail
object
Bad request detail.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-legacy-backup-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 Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
Where this information came from

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