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.

Important

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¶

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/{groupId}/serverless/{instanceName}/backup/restoreJobs	Return all restore jobs of one serverless instance.
`GET`	/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs/{JOB-ID}	Get one Cloud Backup restore jobs for the specified cluster.
`GET`	/groups/{groupId}/serverless/{instanceName}/backup/restoreJobs/{restoreJobId}	Return one restore job of one serverless instance.
`POST`	/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/restoreJobs	Restore one snapshot for the specified cluster. All requests to this endpoint must originate from an IP address in the organization's API access list. Tip See also: Required for Select Resources: API Resource Request Access Lists
`POST`	/groups/{groupId}/serverless/{instanceName}/backup/restoreJobs	Restore one snapshot for the specified serverless instance. All requests to this endpoint must originate from an IP address in the organization's API access list. Tip See also: Required for Select Resources: API Resource Request Access Lists
`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 in the organization's API access list. Tip See also: Required for Select Resources: API Resource Request Access Lists

← Return All Snapshots Of One Serverless Instance Get All Cloud Backup Restore Jobs →