Navigation

Update 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. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

Resource

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

Request Parameters

Request Path Parameters

Parameter Type Description
GROUP-ID string (Required.) The unique identifier for the group that holds the cluster with the snapshot schedule you want to update.
CLUSTER-ID string (Required.) The unique indentifier of the cluster whose snapshot schedule you want to update.

Request Query Parameters

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

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

Indicates whether or not to wrap the response in an 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:

status
HTTP response code
envelope
The expected response body
false

Request Body Parameters

Name Type Description
groupId string Unique identifier of the group that owns the backup configuration.
clusterId string Unique identifier of the cluster to which this backup configuration applies.
snapshotIntervalHours number Number of hours between snapshots. Supported values are 6, 8, 12, and 24.
snapshotRetentionDays number Number of days to keep recent snapshots. Supported values are 2 - 5.
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. Supported values are 15, 30, and 60.
dailySnapshotRetentionDays number

Number of days to retain daily snapshots. Supported values are 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360.

Note

If you set dailySnapshotRetentionDays to 0, this rule is disabled.

weeklySnapshotRetentionWeeks number

Number of weeks to retain weekly snapshots. Supported values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, and 52.

Note

If you set weeklySnapshotRetentionWeeks to 0, this rule is disabled.

monthlySnapshotRetentionMonths number

Number of months to retain monthly snapshots. Supported values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, and 36.

Note

If you set monthlySnapshotRetentionMonths to 0, this rule is disabled.

pointInTimeWindowHours number Number of hours in the past for which a point-in-time snapshot can be created.
referenceHourOfDay number Hour of the day to schedule snapshots using a 24 hour clock. The default value is 0 (midnight). Supported values are 0 - 23.
referenceMinuteOfHour number Minute of the hour to schedule snapshots. The default value is 0. Supported values are 0 - 59.
referenceTimeZoneOffset string The ISO-8601 timezone offset where the Ops Manager host resides. To avoid problems with daylight saving time, use UTC. The default value is +0000, which is equivalent to UTC. Z is also a supported value and equivalent to UTC.

Response

Name Type Description
groupId string Unique identifier of the group that owns the backup configuration.
clusterId string Unique identifier of the cluster to which this backup configuration applies.
snapshotIntervalHours number Number of hours between snapshots. Supported values are 6, 8, 12, and 24.
snapshotRetentionDays number Number of days to keep recent snapshots. Supported values are 2 - 5.
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. Supported values are 15, 30, and 60.
dailySnapshotRetentionDays number Number of days to retain daily snapshots. Supported values are 0, 3, 4, 5, 6, 7, 15, 30, 60, 90, 120, 180, 360.
weeklySnapshotRetentionWeeks number Number of weeks to retain weekly snapshots. Supported values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 12, 16, 20, 24, and 52.
monthlySnapshotRetentionMonths number Number of months to retain monthly snapshots. Supported values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 18, 24, and 36.
pointInTimeWindowHours number Number of hours in the past for which a point-in-time snapshot can be created.
referenceHourOfDay number Hour of the day to schedule snapshots using a 24 hour clock. The default value is 0 (midnight) and supported values are 0 - 23.
referenceMinuteOfHour number Minute of the hour to schedule snapshots. The default value is 0 and supported values are 0 - 59.
referenceTimeZoneOffset string The ISO-8601 timezone offset where the Ops Manager host resides. To avoid problems with daylight saving time, use UTC. The default value is +0000, which is equivalent to UTC. Z is also a supported value and equivalent to UTC.
links object array One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification

Example Request

curl --user "{username}:{apiKey}" --digest \
 --header "Accept: application/json" \
 --header "Content-Type: application/json" \
 --include \
 --request PATCH "https://{opsManagerHost}:{port}/api/public/v1.0/groups/525ec8394f5e625c80c7404a/backupConfigs/53bc556ce4b049c88baec825/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}

Response Body

{
  "clusterId" : "53bc556ce4b049c88baec825",
  "dailySnapshotRetentionDays" : 15,
  "groupId" : "525ec8394f5e625c80c7404a",
  "links" : [],
  "monthlySnapshotRetentionMonths" : 6,
  "pointInTimeWindowHours": 24,
  "snapshotIntervalHours" : 8,
  "snapshotRetentionDays" : 2,
  "weeklySnapshotRetentionWeeks" : 4
}