- API >
- API Resources >
- Cloud Provider and On-Demand Snapshots
Cloud Provider and On-Demand Snapshots¶
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
.
Cloud Provider Snapshots Only
This resource only applies to clusters using Cloud Provider Snapshots.
The /backup/snapshots
resource enables you to view and delete
Cloud Provider Snapshots.
Endpoints¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Method | Endpoint | Description |
---|---|---|
GET |
/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/snapshots | Get all cloud provider snapshots for the specified cluster. |
GET |
/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/snapshots/{SNAPSHOT-ID} | Get the snapshot associated with {SNAPSHOT-ID} |
DELETE |
/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/snapshots/{SNAPSHOT-ID} | Delete the snapshot associated with All requests to this endpoint must originate from an IP address on the Atlas user’s API whitelist. For complete documentation on configuring API whitelists, see Enable API Whitelisting for Your Organization. |
POST |
/groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/backup/snapshots | Take an on-demand snapshot. |