mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-06 21:18:31 +00:00
29ff05cbac
* [DOCS] Updating snapshot/restore pages to align with API changes (#59730) * Updating snapshot/restore pages to align with API changes. * Fixing texts in delete snapshot page. * Removing duplicate code sample and making editorial changes. * Change "deleted" to "delete" * Incorporating review feedback and making minor editorial changes. * Remove titleabbrev * Add paragraph break * Remove titleabbrev from restore page * Remove titleabbrev from create page * Change "Create" to lowercase * Change API names to lowercase * Remove extraneous delimiters * Change "Delete" to lowercase * Single-sourcing warning and clarifying warning text. * Fixing tests and removing erroneous example.
48 lines
1.3 KiB
Plaintext
48 lines
1.3 KiB
Plaintext
[[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*
|
|
-----------------------------------
|