Navigation

Get the Snapshot Schedule

Important With Circle IconCreated with Sketch.Important
Legacy Backup Deprecated

MongoDB deprecated the Legacy Backup feature. Clusters that use Legacy Backup can continue to use it. MongoDB recommends using Cloud Backups. Effective 23 March 2020, all new clusters can only use Cloud Backups.

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.

The Atlas API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.

To learn how to configure API access for an Atlas project, see Configure Atlas API Access.

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

GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/snapshotSchedule
ParameterNecessityDescription
GROUP-IDRequiredUnique identifier for the project.
CLUSTER-NAMERequiredName of the cluster.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

This endpoint does not use HTTP request body parameters.

NameTypeDescription
groupIdstringUnique identifier of the project.
clusterIdstringUnique identifier of the cluster.
snapshotIntervalHoursnumberNumber of hours between snapshots.
snapshotRetentionDaysnumberNumber of days to keep recent snapshots.
dailySnapshotRetentionDaysnumberNumber of days to retain daily snapshots.
pointInTimeWindowHoursnumberNumber of hours in the past for which a Continuous Cloud Backup snapshot can be created.
clusterCheckpointIntervalMinnumberNumber of minutes between successive cluster checkpoints. This only applies to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.
weeklySnapshotRetentionWeeksnumberNumber of weeks to retain weekly snapshots.
monthlySnapshotRetentionMonthsnumberNumber of months to retain monthly snapshots.
linksarrayArray of related resources. See Linking for details.
curl -X GET -i -u "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
"https://cloud.mongodb.com/api/atlas/v1.0/groups/6c7498dg87d9e6526801572b/clusters/Cluster0/snapshotSchedule"
{
"clusterId" : "7c2487d833e9e75286093696",
"dailySnapshotRetentionDays" : 7,
"groupId" : "6c7498dg87d9e6526801572b",
"links" : [ ... ],
"monthlySnapshotRetentionMonths" : 13,
"pointInTimeWindowHours" : 24,
"snapshotIntervalHours" : 6,
"snapshotRetentionDays" : 2,
"weeklySnapshotRetentionWeeks" : 4
}
Give Feedback