• API >
• Public API Resources >
• Backup and Restore >
• Snapshots >
• Remove One Snapshot from a Cluster

Remove One Snapshot from a Cluster

All requests to this endpoint must originate from an IP address on the Cloud Manager user’s API whitelist. For complete documentation on configuring API whitelists, see Enable API Whitelisting for Your Organization.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource

copy

DELETE /groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}

Request Parameters

Request Path Parameters

Name	Type	Description
PROJECT-ID	string	Unique identifier of the project that owns the snapshot.
CLUSTER-ID	string	Unique identifier of the cluster that the snapshot represents.
SNAPSHOT-ID	string	Unique identifier of the snapshot.

Request Query Parameters

The following query parameters are optional:

Name	Type	Necessity	Description	Default
pretty	boolean	Optional	Flag indicating whether the response body should be in a prettyprint format.	false
envelope	boolean	Optional	Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes: Name Description status HTTP response code envelope Expected response body	false

Request Body Parameters

This endpoint does not use HTTP request body parameters.

Response

This endpoint does not have response elements.

Example Request

copy

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --include \
 --request DELETE "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}"

Example Response

This endpoint does not return a response body.

←   Change the Expiry of One Snapshot Get All Snapshots for One Config Server  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.