- API >
- Public API Resources >
- Snapshot Schedule
Snapshot Schedule¶
On this page
This resource allows you to view and configure various properties of snapshot creation and retention for a replica set or cluster. In order to modify this resource, the request must originate from an IP address on the API user’s whitelist.
Operations¶
GET /api/public/v1.0/groups/GROUP-ID/backupConfigs/CLUSTER-ID/snapshotSchedule
- Get the snapshot schedule for a cluster.CLUSTER-ID
must be the ID of either a replica set or a sharded cluster.PATCH /api/public/v1.0/groups/GROUP-ID/backupConfigs/CLUSTER-ID/snapshotSchedule
- Change the parameters of snapshot creation and retention. Any combination of the snapshot schedule’s attributes can be modified.
Sample Entity¶
Entity Fields¶
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 | integer | Number of hours between snapshots. Supported values are 6, 8, 12, and 24. |
snapshotRetentionDays | integer | Number of days to keep recent snapshots. Supported values are 1 - 5. |
clusterCheckpointIntervalMin | integer | 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. |
dailySnapshotRetentionDays | integer | Number of days to retain daily snapshots. Supported values are 1 - 365. |
weeklySnapshotRetentionWeeks | integer | Number of weeks to retain weekly snapshots. Supported values are 1 - 52. |
monthlySnapshotRetentionMonths | integer | Number of months to retain monthly snapshots. Supported values are 1 - 36. |
Links¶
Relation | Description |
---|---|
self | Me |
cluster | The cluster that this backup configuration is for. |
group | The group that owns this backup configuration. |
backupConfig | The backup configuration that this schedule belongs to. |