Delete snapshots
- DELETE /_snapshot/{repository}/{snapshot}
Required authorization
- Cluster privileges manage
Query parameters
-
master_timeoutstring · default: 30s -
The 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. To indicate that the request should never timeout, set it to
-1. -
wait_for_completionboolean · default: true -
If
false, the request returns a response as soon as the deletes are scheduled. Iftrue, the request returns a response when the matching snapshots are all deleted, and the post-deletion cleanup work associated with the request has completed. If you make several requests to the delete-snapshots API targetting overlapping collections of snapshots then some of those requests may perform different parts of the associated post-deletion cleanup work, returning their responses at different times. For example, if you make two requests to delete the same snapshot then sometimes all of the post-deletion cleanup work will be associated with the first request, delaying its response, while the second request has no associated post-deletion cleanup work and receives its response as soon as the snapshot has been deleted.