Delete snapshots

DELETE /_snapshot/{repository}/{snapshot}

Auth

Required authorization

Cluster privileges manage

Path parameters

repository string required: The name of the repository to delete a snapshot from.
snapshot string required: A comma-separated list of snapshot names to delete. It also accepts wildcards (*).

Query parameters

master_timeout string · 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_completion boolean · default: true: If true, the request returns a response when the matching snapshots are all deleted. If false, the request returns a response as soon as the deletes are scheduled.

Response

application/json

acknowledged boolean required: For a successful response, this value is always true. On failure, an exception is returned instead.

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

DELETE /_snapshot/my_repository/snapshot_2,snapshot_3

JavaScript Elasticsearch JavaScript Client

const response = await client.snapshot.delete({
  repository: "my_repository",
  snapshot: "snapshot_2,snapshot_3",
});

Python Elasticsearch Python Client

resp = client.snapshot.delete(
    repository="my_repository",
    snapshot="snapshot_2,snapshot_3",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_2,snapshot_3" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.snapshot().delete(d -> d
    .repository("my_repository")
    .snapshot("snapshot_2,snapshot_3")
);

C# Elasticsearch .NET Client

var response = await client.Snapshot.DeleteAsync(repository: "my_repository", snapshot: "snapshot_2,snapshot_3");

PHP Elasticsearch PHP Client

$resp = $client->snapshot()->delete([
    "repository" => "my_repository",
    "snapshot" => "snapshot_2,snapshot_3",
]);

Ruby Elasticsearch Ruby Client

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

Response

A successful response from DELETE /_snapshot/my_repository/snapshot_2,snapshot_3. The request deletes snapshot_2 and snapshot_3 from the repository named my_repository.

{
  "acknowledged" : true
}