- API >
- Public API Resources >
- Backup and Restore >
- Snapshots
Snapshots¶
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.
This resource allows you to view metadata of, change the expiration date
for, and remove existing snapshots. A snapshot is a complete copy of the
data in a mongod instance at a point in time.
You can retrieve snapshot metadata for the whole cluster or replica set, or for a single config server in a cluster.
To restore the snapshot data, you must create a restore job.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Endpoints¶
The following lists the endpoints available for snapshots.
| Method | Endpoint | Description |
|---|---|---|
| GET | /groups/{groupId}/clusters/{clusterId}/snapshots | Get All Snapshots for a Cluster |
| GET | /groups/{groupId}/clusters/{clusterId}/snapshots/{snapshotId} | Get one snapshot for a cluster. |
| PATCH | /groups/{groupId}/clusters/{clusterId}/snapshots/{snapshotId} | Change expiration date for one snapshot. |
| DELETE | /groups/{groupId}/clusters/{clusterId}/snapshots/{snapshotId} | Remove one snapshot. Important To delete a snapshot, you must issue the request from an IP address on your user account’s whitelist. |
Deprecated when using MongoDB 3.4
As of MongoDB 3.4, mirrored config server deployments (also known as SCCC) are no longer supported. The following API methods work with SCCC config servers only. To learn how to convert your config servers from SCCC to a replica set (also known as CSRS), see Upgrade Config Servers to Replica Set in the MongoDB Server Manual.
| Method | Endpoint | Description |
|---|---|---|
| GET | /groups/{groupId}/hosts/{hostId}/snapshots | Get all snapshots for a config server. |
| GET | /groups/{groupId}/hosts/{hostId}/snapshots/{snapshotId} | Get one snapshot for a config server. |