Delete snapshot API | Elasticsearch Guide [master]

You are looking at preliminary documentation for a future release. Not what you want? See the current release documentation.

› › ›

Delete snapshot APIedit

Deletes a snapshot.

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

DELETE /_snapshot/my_repository/my_snapshot

DELETE /_snapshot/<repository>/<snapshot>

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

<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 (*).

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.

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

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

DELETE /_snapshot/my_repository/snapshot_2,snapshot_3

The API returns the following response:

{
  "acknowledged" : true
}