Navigation

Cloud Provider Snapshot 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 Provider Snapshots Only

This resource only applies to clusters using Cloud Provider Snapshots.

The /backup/restoreJobs resource enables you to create or view restore jobs for an Atlas cluster with Cloud Provider Snapshots 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 provider snapshot restore jobs for the specified cluster.
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs/{JOB-ID} Get one cloud provider snapshot restore jobs for the specified cluster.
POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs

Create a new restore job from a cloud provider snapshot 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 Provide Access to Whitelisted API Operations.

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

Cancels the cloud provider snapshot 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 Provide Access to Whitelisted API Operations.