|
@@ -0,0 +1,56 @@
|
|
|
+[[delete-snapshot-repo-api]]
|
|
|
+=== Delete snapshot repository API
|
|
|
+++++
|
|
|
+<titleabbrev>Delete snapshot repository</titleabbrev>
|
|
|
+++++
|
|
|
+
|
|
|
+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-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}
|
|
|
+
|
|
|
+`master_timeout`::
|
|
|
+(Optional, <<time-units, 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, 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`.
|