- API >
- API Resources >
- Checkpoints >
- Get All Checkpoints
Get All Checkpoints¶
On this page
Get all checkpoints for a sharded cluster.
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. The resource and corresponding endpoints use the
term groups
.
The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.
For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
Request Parameters¶
Request Path Parameters¶
Path Element | Required/Optional | Description |
---|---|---|
{GROUP-ID} |
Required. | The unique identifier of the project that owns the checkpoints. |
{CLUSTER-NAME} |
Required | The name of the cluster that contains the checkpoints that you want to retrieve. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Atlas API resources. These are all optional.
Name | Type | Description | Default |
---|---|---|---|
pageNum |
integer | Page number (1-based). | 1 |
itemsPerPage |
integer | Number of items to return per page, up to a maximum of 500. | 100 |
pretty |
boolean | Displays response in a prettyprint format. | false |
envelope |
boolean | Specifies whether or not to wrap the response in an envelope. | false |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects, and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results |
object array | Includes one object for each item detailed in the results array section. |
links |
object array | Includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount |
number | Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results array¶
Each result
is one cluster checkpoint.
Name | Type | Description |
---|---|---|
clusterId |
string | ID of the cluster containing the checkpoint. |
completed |
BSON timestamp | The point in time the checkpoint completed and the balancer restarted. |
groupId |
string | The unique identifier of the project that owns the checkpoint. |
id |
string | The checkpoint ID. |
links |
array of objects | This array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
parts |
array of objects | The individual parts that comprise the complete checkpoint. There will be one element for each shard plus one element for the config servers. |
parts[i].replicaSetName |
string | Name of the replica set. Not present for config servers. |
parts[i].shardName |
string | The name of the shard. |
parts[i].tokenDiscovered |
Boolean | Indicates whether the token exists. |
parts[i].tokenTimestamp |
document | The timestamp of the checkpoint token entry in the oplog,
as specified by the entry’s
|
parts[i].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 Atlas stopped the balancer and began the checkpoint. |
timestamp |
BSON timestamp | The point in time the checkpoint restores to. |