Navigation

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

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

Request Parameters

Request Path Parameters

Name Type Description
GROUP-ID string Unique identifier of the group 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 Description Default
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

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:

status
HTTP response code
envelope
The 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

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

Example Response

This endpoint does not return a response body.