Navigation

Get the Snapshot 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.

The Atlas API uses HTTP Digest Authentication. Provide your Atlas username and API key as the username and password when constructing the HTTP request.

For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.

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

Syntax

GET /api/atlas/v1.0/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/snapshotSchedule

Request Parameters

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required. The unique identifier for the project.
CLUSTER-NAME Required. The name of the cluster.

Request Query Parameters

This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.

Name Type Description Default
pretty boolean Display response in a prettyprint format. false
envelope boolean Specifies whether or not to wrap the response in an envelope. false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

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 point-in-time 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 point-in-time restores 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.

Example Request

Example Request

curl -X GET -i -u "{username}:{apiKey}" --digest \
  "https://cloud.mongodb.com/api/atlas/v1.0/groups/6c7498dg87d9e6526801572b/clusters/Cluster0/snapshotSchedule"

Example Response

{
   "clusterId" : "7c2487d833e9e75286093696",
   "dailySnapshotRetentionDays" : 7,
   "groupId" : "6c7498dg87d9e6526801572b",
   "links" : [ ... ],
   "monthlySnapshotRetentionMonths" : 13,
   "pointInTimeWindowHours" : 24,
   "snapshotIntervalHours" : 6,
   "snapshotRetentionDays" : 2,
   "weeklySnapshotRetentionWeeks" : 4
}