Docs Menu

Docs HomeMongoDB Cloud Manager

Remove One Snapshot from a Cluster

On this page

  • Resource
  • Required Permissions
  • Request Parameters
  • Request Path Parameters
  • Request Query Parameters
  • Request Body Parameters
  • Response
  • Example Request
  • Example Response

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

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

You must have the Global Backup Admin or Global Owner role to delete a snapshot that is within Point-in-Time restore window.

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.

The following query parameters are optional:

Name
Type
Necessity
Description
Default
pretty
boolean
Optional
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

This endpoint doesn't use HTTP request body parameters.

This endpoint does not have response elements.

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}"

This endpoint doesn't return a response body.

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