Skip to content

Commit

Permalink
[DOCS] Add delete snapshot repo API docs (#57043)
Browse files Browse the repository at this point in the history
Changes:

* Adds API reference docs for the delete snapshot repo API.

* Corrects an error in the delete snapshot repo API spec. Comma-separated
repository names are not supported.

* Relocates the existing delete snapshot repo API example docs.
  • Loading branch information
jrodewig authored May 21, 2020
1 parent 902f0cd commit e68a2ec
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 14 deletions.
56 changes: 56 additions & 0 deletions docs/reference/snapshot-restore/apis/delete-repo-api.asciidoc
Original file line number Diff line number Diff line change
@@ -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`.
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ content may not be included yet.
=== Snapshot repository management APIs

* <<clean-up-snapshot-repo-api,Clean up snapshot repository>>
* <<delete-snapshot-repo-api,Delete snapshot repository>>
* <<put-snapshot-repo-api,Put snapshot repository>>


include::clean-up-repo-api.asciidoc[]
include::delete-repo-api.asciidoc[]
include::put-repo-api.asciidoc[]
12 changes: 12 additions & 0 deletions docs/reference/snapshot-restore/register-repository.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,18 @@ or
GET /_snapshot/_all
-----------------------------------

You can unregister a repository using the <<delete-snapshot-repo-api,delete
snapshot repository API>>:

[source,console]
-----------------------------------
DELETE /_snapshot/my_backup
-----------------------------------

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.

[float]
[[snapshots-filesystem-repository]]
=== Shared file system repository
Expand Down
13 changes: 0 additions & 13 deletions docs/reference/snapshot-restore/take-snapshot.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -192,16 +192,3 @@ snapshot and not used by any other snapshots. If the deleted snapshot operation
created the snapshotting process will be aborted and all files created as part of the snapshotting process will be
cleaned. Therefore, the delete snapshot operation can be used to cancel long running snapshot operations that were
started by mistake.

A repository can be unregistered using the following command:

[source,console]
-----------------------------------
DELETE /_snapshot/my_backup
-----------------------------------
// TEST[continued]

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.


Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"parts":{
"repository":{
"type":"list",
"description":"A comma-separated list of repository names"
"description":"Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported."
}
}
}
Expand Down

0 comments on commit e68a2ec

Please sign in to comment.