Navigation

M2/M5 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.

Note

This resource only applies to M2 and M5 shared-tier clusters.

The /backup/tenant/restores resource enables you to view and create restore jobs from M2 and M5 clusters.

Endpoints

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

Method Endpoint Description
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/tenant/restores Get all restore jobs for the specified M2 or M5 cluster.
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/tenant/restores/{RESTORE-ID} Get the restore job associated to {RESTORE-ID}.
POST /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/tenant/restore

Create a new restore job from an M2 or M5 cluster snapshot 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 Enable API Whitelisting for Your Organization.