This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Delete snapshot repository API
editDelete snapshot repository API
editUnregisters 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.
resp = client.snapshot.delete_repository(
name="my_repository",
)
print(resp)
response = client.snapshot.delete_repository( repository: 'my_repository' ) puts response
const response = await client.snapshot.deleteRepository({
name: "my_repository",
});
console.log(response);
DELETE /_snapshot/my_repository
Request
editDELETE /_snapshot/<repository>
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
managecluster 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)
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. Defaults to
30s. Can also be set to-1to indicate that the request should never timeout. -
timeout -
(Optional, time units) Period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.
Defaults to
30s. Can also be set to-1to indicate that the request should never timeout.