Navigation

Cloud Backup Restore Jobs

Note

Groups and projects are synonymous terms. Your {GROUP-ID} is the same as your project ID. For existing groups, your group/project ID remains the same. The resource and corresponding endpoints use the term groups.

Cloud Backups Only

This resource only applies to clusters using Cloud Backups.

The /backup/restoreJobs resource enables you to create or view restore jobs for an Atlas cluster with Cloud Backups enabled.

Endpoints

Base URL: https://cloud.mongodb.com/api/atlas/v1.0

Method Endpoint Description
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs Get all Cloud Backup restore jobs for the specified cluster.
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs/{JOB-ID} Get one Cloud Backup restore jobs for the specified cluster.
POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs

Create a new restore job from a Cloud Backup associated to the specified cluster.

All requests to this endpoint must originate from an IP address on the Atlas user’s API whitelist. For complete documentation on configuring API whitelists, see Enable API Whitelisting for Your Organization.

DELETE /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs/{JOB-ID}

Cancels the Cloud Backup manual download restore job associated to {JOB-ID}.

All requests to this endpoint must originate from an IP address on the Atlas user’s API whitelist. For complete documentation on configuring API whitelists, see Enable API Whitelisting for Your Organization.