Delete snapshot APIedit
Deletes a snapshot.
DELETE /_snapshot/my_repository/my_snapshot
Requestedit
DELETE /_snapshot/<repository>/<snapshot>
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
managecluster privilege to use this API.
Path parametersedit
-
<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 parametersedit
-
master_timeout -
(Optional, time units)
Period to wait for a connection to the master node. If no response is received
before the timeout expires, the request fails and returns an error. Defaults to
30s.
Exampleedit
The following request deletes snapshot_2 and snapshot_3 from the repository named my_repository.
DELETE /_snapshot/my_repository/snapshot_2,snapshot_3
The API returns the following response:
{
"acknowledged" : true
}