mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
60 lines
1.4 KiB
Text
60 lines
1.4 KiB
Text
[[delete-snapshot-repo-api]]
|
|
=== Delete snapshot repository API
|
|
++++
|
|
<titleabbrev>Delete snapshot repository</titleabbrev>
|
|
++++
|
|
|
|
.New API reference
|
|
[sidebar]
|
|
--
|
|
For the most up-to-date API details, refer to {api-es}/group/endpoint-snapshot[Snapshot and restore APIs].
|
|
--
|
|
|
|
Unregisters one or more <<snapshots-register-repository,snapshot repositories>>.
|
|
|
|
When a repository is unregistered, {es} only removes the reference to the
|
|
location where the repository is storing the snapshots. The snapshots themselves
|
|
are left untouched and in place.
|
|
|
|
////
|
|
[source,console]
|
|
----
|
|
PUT /_snapshot/my_repository
|
|
{
|
|
"type": "fs",
|
|
"settings": {
|
|
"location": "my_backup_location"
|
|
}
|
|
}
|
|
----
|
|
////
|
|
|
|
[source,console]
|
|
----
|
|
DELETE /_snapshot/my_repository
|
|
----
|
|
// TEST[continued]
|
|
|
|
[[delete-snapshot-repo-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`DELETE /_snapshot/<repository>`
|
|
|
|
[[delete-snapshot-repo-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage`
|
|
<<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[delete-snapshot-repo-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<repository>`::
|
|
(Required, string)
|
|
Name of the snapshot repository to unregister. Wildcard (`*`) patterns are
|
|
supported.
|
|
|
|
[[delete-snapshot-repo-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
|