Get the Snapshot Schedule


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.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0


GET /api/public/v1.0/groups/GROUP-ID/backupConfigs/CLUSTER-ID/snapshotSchedule

Request Parameters

Request Path Parameters

Parameter Required/Optional Description
GROUP-ID Required. The unique identifier for the group that holds the cluster with the snapshot schedule you want to get.
CLUSTER-ID Required. The unique indentifier of the cluster whose snapshot schedule you want to get.

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
pageNum integer Page number (1-based). 1
itemsPerPage integer Maximum number of items to return, up to a maximum of 100. 100
pretty boolean Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean

Flag indicating 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, response body includes:

status HTTP response code
envelope The expected response body

For endpoints that return a list of results, the results object is an envelope. Ops Manager adds the status field to the response body.


Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response Elements

Name Type Description
groupId string ID of the group that owns the backup configuration.
clusterId string ID 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 1 - 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 1 - 365.
weeklySnapshotRetentionWeeks number Number of weeks to retain weekly snapshots. Supported values are 1 - 52.
monthlySnapshotRetentionMonths number Number of months to retain monthly snapshots. Supported values are 1 - 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. Default value is 0 (midnight), and supported values are 0 - 23.
referenceMinuteOfHour number Minute of the hour to schedule snapshots. 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 is +0000, which is equivalent to UTC. Z is also a supported value and equivalent to UTC.
links string array
Relation Description
self Me
http://{opsManagerHost}:{port}/cluster The cluster that this backup configuration is for.
http://{opsManagerHost}:{port}/group The group that owns this backup configuration.
http://{opsManagerHost}:{port}/backupConfig The backup configuration that this schedule belongs to.


Example Request

curl -i -u "{username}:{apiKey}" --digest -X GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/525ec8394f5e625c80c7404a/backupConfigs/53bc556ce4b049c88baec825/snapshotSchedule"

Example Response

HTTP/1.1 200 OK
  "groupId" : "525ec8394f5e625c80c7404a",
  "clusterId" : "53bc556ce4b049c88baec825",
  "snapshotIntervalHours" : 6,
  "snapshotRetentionDays" : 2,
  "dailySnapshotRetentionDays" : 7,
  "weeklySnapshotRetentionWeeks" : 4,
  "monthlySnapshotRetentionMonths" : 13,
  "pointInTimeWindowHours": 24,
  "links": [ ... ]