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

Delete snapshot repository API

edit

Delete snapshot repository API

edit

Unregisters one or more snapshot repositories.

When a repository is unregistered, Elasticsearch only removes the reference to the location where the repository is storing the snapshots. The snapshots themselves are left untouched and in place.

DELETE /_snapshot/my_repository

Request

edit

DELETE /_snapshot/<repository>

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 snapshot repository to unregister. Wildcard (*) patterns are supported.

Query parameters

edit
master_timeout
(Optional, time units) Specifies the period of time 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.
timeout
(Optional, time units) Specifies the period of time to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.
« Get snapshot repository API Clean up snapshot repository API »