› › ›

Delete snapshot API

resp = client.snapshot.delete(
    repository="my_repository",
    snapshot="my_snapshot",
)
print(resp)

response = client.snapshot.delete(
  repository: 'my_repository',
  snapshot: 'my_snapshot'
)
puts response

const response = await client.snapshot.delete({
  repository: "my_repository",
  snapshot: "my_snapshot",
});
console.log(response);

DELETE /_snapshot/my_repository/my_snapshot

Request

DELETE /_snapshot/<repository>/<snapshot>

Prerequisites

If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API.

Path parameters

<repository>: (Required, string) Name of the repository to delete a snapshot from.
<snapshot>: (Required, string) Comma-separated list of snapshot names to delete. Also accepts wildcards (*).

Query parameters

master_timeout: (Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
wait_for_completion: (Optional, Boolean) If true, the request returns a response when the matching snapshots are all deleted. If false, the request returns a response as soon as the deletes are scheduled. Defaults to true.

Example

The following request deletes snapshot_2 and snapshot_3 from the repository named my_repository.

resp = client.snapshot.delete(
    repository="my_repository",
    snapshot="snapshot_2,snapshot_3",
)
print(resp)

response = client.snapshot.delete(
  repository: 'my_repository',
  snapshot: 'snapshot_2,snapshot_3'
)
puts response

const response = await client.snapshot.delete({
  repository: "my_repository",
  snapshot: "snapshot_2,snapshot_3",
});
console.log(response);

DELETE /_snapshot/my_repository/snapshot_2,snapshot_3

The API returns the following response:

{
  "acknowledged" : true
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-snapshot-api.html