Delete snapshot API

Delete snapshot API

Deletes a snapshot.

  1. 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 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.

Example

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

  1. DELETE /_snapshot/my_repository/snapshot_2,snapshot_3

The API returns the following response:

  1. {
  2.   "acknowledged" : true
  3. }