Navigation

Get the Snapshot Schedule

On this page

  • Syntax
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • Example Request
  • Example Request
  • Example Response
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.

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
Parameter
Necessity
Description
GROUP-ID
Required
Unique identifier for the project.
CLUSTER-NAME
Required
Name of the cluster.

This endpoint might use any of the HTTP request query parameters available to all Atlas API resources. All of these are optional.

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
Flag indicating whether the response body should be in a prettyprint format.
false
envelope
boolean
Optional

Flag indicating if Atlas should wrap the response in a JSON envelope.

This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query.

For endpoints that return one result, the response body includes:

status
HTTP response code
envelope
Expected response body
false

This endpoint does not use HTTP request body parameters.

Name
Type
Description
groupId
string
Unique identifier of the project.
clusterId
string
Unique identifier of the cluster.
snapshotIntervalHours
number
Number of hours between snapshots.
snapshotRetentionDays
number
Number of days to keep recent snapshots.
dailySnapshotRetentionDays
number
Number of days to retain daily snapshots.
pointInTimeWindowHours
number
Number of hours in the past for which a Continuous Cloud Backup snapshot can be created.
clusterCheckpointIntervalMin
number
Number of minutes between successive cluster checkpoints. This only applies to sharded clusters. This number determines the granularity of continuous cloud backups for sharded clusters.
weeklySnapshotRetentionWeeks
number
Number of weeks to retain weekly snapshots.
monthlySnapshotRetentionMonths
number
Number of months to retain monthly snapshots.
links
array
Array 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

On this page

  • Syntax
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response Elements
  • Example Request
  • Example Request
  • Example Response