Delete snapshot

Introduced 1.0

Deletes a snapshot from a repository.

Deleting a snapshot that is in progress stops the snapshot operation and deletes the partially created snapshot.

• To learn more about snapshots, see Snapshots.

• To view a list of your repositories, see cat repositories.

• To view a list of your snapshots, see cat snapshots.

Path and HTTP method

DELETE _snapshot/<repository>/<snapshot>

Path parameters

Example request

The following request deletes a snapshot called my-first-snapshot from the my-opensearch-repo repository:

DELETE /_snapshot/my-opensearch-repo/my-first-snapshot

response = client.snapshot.delete(
  repository = "my-opensearch-repo",
  snapshot = "my-first-snapshot"
)

Example response

Upon success, the response returns the following JSON object:

{
  "acknowledged": true
}

To verify that the snapshot was deleted, use the Get snapshot API, passing the snapshot name as the snapshot path parameter.