Spec-Zone.ru › Elasticsearch 7
›Elasticsearch Guide [7.17] ›REST APIs ›Snapshot and restore APIs

Delete snapshot API

Deletes a snapshot.

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.

DELETE /_snapshot/my_repository/snapshot_2,snapshot_3

The API returns the following response:

{
  "acknowledged" : true
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/delete-snapshot-api.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API