Cloud Backup Schedule¶
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
Applies to Scheduled Cloud Backups Only
This resource applies to:
- Clusters using Cloud Backups and
- Scheduled snapshots, not on-demand snapshots.
The /backup/schedule resource enables you to view and modify
the snapshot scheduling and retention settings for an Atlas
cluster with Cloud Backups enabled.
https://cloud.mongodb.com/api/atlas/v1.0
Endpoints¶
Method | Endpoint | Description |
|---|---|---|
GET | Get the current snapshot schedule and retention settings for the
cluster with {CLUSTER-NAME}. | |
PATCH | Modify the snapshot schedule or retention settings for the
cluster with All requests to this endpoint must originate from an IP address in the organization's API access list. | |
DELETE | Delete all the snapshot schedules for the cluster with
{CLUSTER-NAME}. |