- API >
- Public API Resources >
- Backup and Restore >
- Checkpoints
Checkpoints¶
On this page
Overview¶
This resource allows you to view Checkpoints metadata. You can use checkpoints to create custom snapshots of a cluster at points in time between regular snapshots.
Endpoints¶
Get All Checkpoints¶
Get all checkpoints for a cluster.
Get One Checkpoint¶
Get a single checkpoint.
Sample Entity¶
Entity Fields¶
Name |
Type | Description |
---|---|---|
clusterId |
string | The ID of the cluster represented by the checkpoint. |
completed |
BSON timestamp | The point-in-time the checkpoint completed and the balancer restarted. |
groupId |
string | The ID of the group that owns the checkpoint. |
id |
string | The checkpoint ID. |
parts |
array of parts | The individual parts that comprise the complete checkpoint. There will be one element for each shard plus one element for the config servers. |
parts.replicaSetName |
string | Name of the replica set. Not present for a config server. |
parts.shardName |
string | The name of the shard. |
parts.tokenDiscovered |
Boolean | Indicates whether the token exists. |
parts.tokenTimestamp |
document | The timestamp of an entry in the oplog, as specified by the
entry’s ts field. The ts field is a BSON timestamp and has two components: the
timestamp, which is the value in seconds since the Unix epoch, and
the increment, which is an incrementing ordinal for operations
within a given second. |
parts.typeName |
string | The type of server represented by the part. Possible values are:
|
restorable |
Boolean | Indicates whether the checkpoint can be used for a restore. |
started |
BSON timestamp | The point-in-time Ops Manager stopped the balancer and began the checkpoint. |
timestamp |
BSON timestamp | The point-in-time the checkpoint restores to. |
Links¶
Relation | Description |
---|---|
self |
The checkpoint |
http://mms.mongodb.com/cluster |
The cluster the checkpoint belongs to. |
http://mms.mongodb.com/group |
The group that owns the checkpoint. |