Delete snapshot repositories Generally available; Added in 0.0.0

DELETE /_snapshot/{repository}
Api key auth Basic auth Bearer auth

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

Required authorization

  • Cluster privileges: manage

Path parameters

  • repository string | array[string] Required

    The ame of the snapshot repositories to unregister. Wildcard (*) patterns are supported.

Query parameters

  • master_timeout string

    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.

    Values are -1 or 0.

  • timeout string

    The 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. To indicate that the request should never timeout, set it to -1.

    Values are -1 or 0.

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • acknowledged boolean Required

      For a successful response, this value is always true. On failure, an exception is returned instead.
DELETE /_snapshot/{repository} 
DELETE /_snapshot/my_repository

resp = client.snapshot.delete_repository(
    name="my_repository",
)
const response = await client.snapshot.deleteRepository({
  name: "my_repository",
});
response = client.snapshot.delete_repository(
  repository: "my_repository"
)
$resp = $client->snapshot()->deleteRepository([
    "repository" => "my_repository",
]);
curl -X DELETE -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_snapshot/my_repository"