Navigation

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.

Create and retrieve restores jobs for a MongoDB cluster. A restore job restores a MongoDB cluster to its state from an existing snapshot.

Endpoints

Method Endpoint Description
GET /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/restoreJobs Retrieve all restore jobs for the specified cluster.
GET /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/restoreJobs/{JOB-ID} Retrieve one restore job for the specified cluster.
POST /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/restoreJobs

Create one restore job for 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.