IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Restore snapshot API Snapshot lifecycle management APIs »
Elastic Docs ›Elasticsearch Guide [7.16] ›REST APIs ›Snapshot and restore APIs

Delete snapshot API

edit

Delete snapshot API

edit

Deletes a snapshot.

DELETE /_snapshot/my_repository/my_snapshot

Request

edit

DELETE /_snapshot/<repository>/<snapshot>

Prerequisites

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

Path parameters

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

Example

edit

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
}
« Restore snapshot API Snapshot lifecycle management APIs »