Navigation

Restore Jobs

The restoreJobs resource allows you to manage restore jobs. A restore job is essentially one request to retrieve one of your existing snapshots, or one snapshot for one recent specific point-in-time, to restore one mongod to one previous state. To initiate one restore job, you must issue the request from an IP address on your user account’s whitelist.

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. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

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

Endpoints

The following lists the endpoints available for restore jobs.

Method Endpoint Description
GET /groups/{GROUP-ID}/clusters/{CLUSTER-ID}/restorejobs Get All Restore Jobs for One Cluster
GET /groups/{GROUP-ID}/clusters/{CLUSTER-ID}/restorejobs?batchid={BATCH-ID} Get All Restore Jobs for One Batch for One Cluster
GET /groups/{GROUP-ID}/clusters/{CLUSTER-ID}/restorejobs/{JOB-ID} Get One Single Restore Job for One Cluster
POST /groups/{GROUP-ID}/clusters/{CLUSTER-ID}/restorejobs Create One Restore Job for One Cluster

Deprecated when using MongoDB 3.4

As of MongoDB 3.4, mirrored config server deployments (also known as SCCC) are no longer supported. The following API methods work with SCCC config servers only. To learn how to convert your config servers from SCCC to a replica set (also known as CSRS), see Upgrade Config Servers to Replica Set in the MongoDB Server Manual.

Method Endpoint Description
GET /groups/{GROUP-ID}/hosts/{HOST-ID}/restorejobs Get All Restore Jobs for One Legacy Mirrored Config Server
GET /groups/{GROUP-ID}/hosts/{HOST-ID}/restorejobs/{JOB-ID} Get One Single Restore Job for One Legacy Mirrored Config Server
POST /groups/{GROUP-ID}/hosts/{HOST-ID}/restorejobs Create One Restore Job for One Legacy Mirrored Config Server