Remove One Snapshot from a Cluster¶

On this page

Resource
Required Permissions
Request Parameters
Response
Example Request
Example Response

All requests to this endpoint must originate from an IP address on the Ops Manager user’s API access list. For complete documentation on configuring API access lists, see Require an API Access List for Your Organization.

Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource¶

copy

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

Required Permissions¶

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

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 doesn’t 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://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}"

Example Response¶

This endpoint doesn’t return a response body.

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