Navigation

Update the Snapshot Schedule

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.

Resource

PATCH /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule

Request Parameters

Request Path Parameters

Parameter Type Necessity Description
PROJECT-ID string Required Unique identifier for the project that holds the cluster with the snapshot schedule you want to update.
CLUSTER-ID string Required Unique indentifier of the cluster whose snapshot schedule you want to update.

Request Query Parameters

The following query parameters are optional:

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

Flag that indicates whether or not to wrap the response in a JSON envelope.

Some API 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:

Name Description
status HTTP response code
envelope Expected response body
false

Request Body Parameters

Name Type Necessity Description
clusterCheckpointIntervalMin number Optional

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. You can set a value of 15, 30, or 60.

Important

You may use checkpoints for clusters that run MongoDB with Feature Compatibility Version of 4.0 or earlier. Checkpoints were removed from MongoDB instances with FCV of 4.2 or later.

clusterId string Optional Unique identifier of the cluster to which this backup configuration applies.
dailySnapshotRetentionDays number Optional

Number of days to retain daily snapshots. You can set a value between 1 and 365, inclusive.

Note

Setting dailySnapshotRetentionDays to 0 disables this rule.

groupId string Optional Unique identifier of the project that owns the backup configuration.
links array of objects Optional One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.
monthlySnapshotRetentionMonths number Optional

Number of months to retain monthly snapshots. You can set a value between 1 and 36, inclusive.

Note

Setting monthlySnapshotRetentionMonths to 0 disables this rule.

pointInTimeWindowHours number Optional Number of hours in the past for which a point-in-time snapshot can be created. You cannot change this value for a snapshot.
snapshotIntervalHours number Optional Number of hours between snapshots. You can set a value of 6, 8, 12, or 24.
snapshotRetentionDays number Optional Number of days to keep recent snapshots. You can set a value between 2 and 5, inclusive.
weeklySnapshotRetentionWeeks number Optional

Number of weeks to retain weekly snapshots. You can set a value between 1 and 52, inclusive.

Note

Setting weeklySnapshotRetentionWeeks to 0 disables this rule.

Response

Name Type Description
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. Cloud Manager may return values of 15, 30, or 60.

Important

You may use checkpoints for clusters that run MongoDB with Feature Compatibility Version of 4.0 or earlier. Checkpoints were removed from MongoDB instances with FCV of 4.2 or later.

clusterId string Unique identifier of the cluster to which this backup configuration applies.
dailySnapshotRetentionDays number

Number of days to retain daily snapshots. Cloud Manager may return values between 1 and 365, inclusive.

Note

Setting dailySnapshotRetentionDays to 0 disables this rule.

groupId string Unique identifier of the project that owns the backup configuration.
links array of objects One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self. The relationships between URLs are explained in the Web Linking Specification.
monthlySnapshotRetentionMonths number

Number of months to retain monthly snapshots. Cloud Manager may return values between 1 and 36, inclusive.

Note

Setting monthlySnapshotRetentionMonths to 0 disables this rule.

pointInTimeWindowHours number Number of hours in the past for which a point-in-time snapshot can be created. You cannot change this value for a snapshot.
snapshotIntervalHours number Number of hours between snapshots. Cloud Manager may return values of 6, 8, 12, or 24.
snapshotRetentionDays number Number of days to keep recent snapshots. Cloud Manager may return values between 2 and 5, inclusive.
weeklySnapshotRetentionWeeks number

Number of weeks to retain weekly snapshots. Cloud Manager may return values between 1 and 52, inclusive.

Note

Setting weeklySnapshotRetentionWeeks to 0 disables this rule.

Example Request

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request PATCH "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/snapshotSchedule" \
     --data '
       {
         "snapshotIntervalHours": 8,
         "dailySnapshotRetentionDays": 15,
         "monthlySnapshotRetentionMonths": 6
       }'

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "clusterId" : "{CLUSTER-ID}",
  "dailySnapshotRetentionDays" : 15,
  "groupId" : "{PROJECT-ID}",
  "links" : [],
  "monthlySnapshotRetentionMonths" : 6,
  "pointInTimeWindowHours": 24,
  "snapshotIntervalHours" : 8,
  "snapshotRetentionDays" : 2,
  "weeklySnapshotRetentionWeeks" : 4
}