- API >
- Public API Resources >
- Backup and Restore >
- Snapshot Schedule >
- Get the Snapshot Schedule
Get the Snapshot Schedule¶
On this page
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.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
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 get. |
CLUSTER-ID |
string | Required | Unique indentifier of the cluster whose snapshot schedule you want to get. |
Request Query Parameters¶
The following query parameters 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 that 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:
|
false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
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.
Ops Manager may return values of Important You may use checkpoints for clusters that run MongoDB with
|
clusterId |
string | Unique identifier of the cluster to which this backup configuration applies. |
dailySnapshotRetentionDays |
number | Number of days to retain daily snapshots. Ops Manager may return
values between Note Setting |
fullIncrementalDayOfWeek |
string | Day of the week when Ops Manager takes a full snapshot. This ensures a recent complete backup. Ops Manager sets the default value to SUNDAY. |
groupId |
string | Unique identifier of the project that owns the backup configuration. |
links |
object array | 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. Ops Manager may return
values between Note Setting |
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.
Ops Manager may return values between 0 and 23 , inclusive. |
referenceMinuteOfHour |
number | Minute of the hour to schedule snapshots. Ops Manager may return
values between 0 and 59 , inclusive. |
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. |
snapshotIntervalHours |
number | Number of hours between snapshots. Ops Manager may return values of
6 , 8 , 12 , or 24 . |
snapshotRetentionDays |
number | Number of days to keep recent snapshots. Ops Manager may return values
between 2 and 5 , inclusive. |
weeklySnapshotRetentionWeeks |
number | Number of weeks to retain weekly snapshots. Ops Manager may return
values between Note Setting |