Navigation

Cloud Backup Schedule

Info With Circle IconCreated with Sketch.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 With Circle IconCreated with Sketch.Important
Applies to Scheduled Cloud Backups Only

This resource applies to:

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

MethodEndpointDescription
GET/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/scheduleGet the current snapshot schedule and retention settings for the cluster with {CLUSTER-NAME}.
PATCH/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/schedule

Modify the snapshot schedule or retention settings for the cluster with {CLUSTER-NAME}.

All requests to this endpoint must originate from an IP address in the organization's API access list.

Bulb IconTip
See Also:
Give Feedback