Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / /

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 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 access list.

Important

Restore delivery via SCP was removed in Ops Manager 4.0.

Note

Groups and projects are synonymous terms. Your {PROJECT-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://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

The following lists the endpoints available for restore jobs.

Method
Endpoint
Description
GET
Get All Restore Jobs for One Cluster
GET
Get All Restore Jobs for One Batch for One Cluster
GET
Get One Restore Job for One Cluster
POST
Create One Restore Job for One Cluster

Important

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
Get All Restore Jobs for One Legacy Mirrored Config Server
GET
Get One Restore Job for One Legacy Mirrored Config Server
POST
Create One Restore Job for One Legacy Mirrored Config Server

Back

Checkpoints

Next

Get All Restore Jobs for One Cluster