-
Notifications
You must be signed in to change notification settings - Fork 25k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[7.8] [DOCS] Updating snapshot/restore pages to align with API changes
- Loading branch information
Adam Locke
authored
Jul 20, 2020
1 parent
69c0e7c
commit c32024b
Showing
6 changed files
with
234 additions
and
268 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
[[delete-snapshots]] | ||
== Delete a snapshot | ||
|
||
//// | ||
[source,console] | ||
----------------------------------- | ||
PUT /_snapshot/my_backup | ||
{ | ||
"type": "fs", | ||
"settings": { | ||
"location": "my_backup_location" | ||
} | ||
} | ||
PUT /_snapshot/my_backup/snapshot_1?wait_for_completion=true | ||
PUT /_snapshot/my_backup/snapshot_2?wait_for_completion=true | ||
PUT /_snapshot/my_backup/snapshot_3?wait_for_completion=true | ||
----------------------------------- | ||
// TESTSETUP | ||
//// | ||
|
||
Use the <<delete-snapshot-api,delete snapshot API>> to delete a snapshot | ||
from the repository: | ||
|
||
[source,console] | ||
---- | ||
DELETE /_snapshot/my_backup/snapshot_1 | ||
---- | ||
|
||
When a snapshot is deleted from a repository, {es} deletes all files associated with the | ||
snapshot that are not in-use by other snapshots. | ||
|
||
If the delete snapshot operation starts while the snapshot is being | ||
created, the snapshot process halts and all files created as part of the snapshotting process are | ||
removed. Use the <<delete-snapshot-api,Delete snapshot API>> to cancel long running snapshot operations that were | ||
started by mistake. | ||
|
||
To delete multiple snapshots from a repository, separate snapshot names by commas or use wildcards: | ||
|
||
[source,console] | ||
----------------------------------- | ||
DELETE /_snapshot/my_backup/snapshot_2,snapshot_3 | ||
DELETE /_snapshot/my_backup/snap* | ||
----------------------------------- |
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
Oops, something went wrong.