Snapshot Schedule
Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
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.
This resource allows you to view and configure various properties of snapshot creation and retention for a replica set or cluster.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Endpoints
The following lists the endpoints available for Edit Snapshot Schedule and Retention Policy.
Method | Endpoint | Description |
|---|---|---|
GET | Get the snapshot schedule for an instance. CLUSTER-ID must be the
ID of either a replica set or a sharded cluster. | |
PATCH | Change the parameters of snapshot creation and retention. Any
combination of the snapshot schedule's attributes can be modified.
CLUSTER-ID must be the ID of either a replica set or a
sharded cluster |