-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Add delete snapshot repo API docs (#57043)
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
Showing
5 changed files
with
71 additions
and
14 deletions.
There are no files selected for viewing
56 changes: 56 additions & 0 deletions
56
docs/reference/snapshot-restore/apis/delete-repo-api.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters