mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
659e0d3fd3
Makes several changes to consolidate snapshot and backup-related docs. Highlights: * Adds info about supported ESS snapshot repository types * Adds docs for Kibana's Snapshot and Restore feature * Combines tutorial pages related to taking and managing snapshots * Consolidates explanations of the snapshot process * Incorporates SLM into the snapshot tutorial * Removes duplicate "back up a cluster" pages
73 lines
1.5 KiB
Text
73 lines
1.5 KiB
Text
[[delete-snapshot-api]]
|
|
=== Delete snapshot API
|
|
++++
|
|
<titleabbrev>Delete snapshot</titleabbrev>
|
|
++++
|
|
|
|
Deletes a <<snapshot-restore,snapshot>>.
|
|
|
|
////
|
|
[source,console]
|
|
----
|
|
PUT /_snapshot/my_repository
|
|
{
|
|
"type": "fs",
|
|
"settings": {
|
|
"location": "my_backup_location"
|
|
}
|
|
}
|
|
|
|
PUT /_snapshot/my_repository/my_snapshot?wait_for_completion=true
|
|
|
|
PUT /_snapshot/my_repository/snapshot_2?wait_for_completion=true
|
|
|
|
PUT /_snapshot/my_repository/snapshot_3?wait_for_completion=true
|
|
----
|
|
// TESTSETUP
|
|
////
|
|
|
|
[source,console]
|
|
-----------------------------------
|
|
DELETE /_snapshot/my_repository/my_snapshot
|
|
-----------------------------------
|
|
|
|
[[delete-snapshot-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`DELETE /_snapshot/<repository>/<snapshot>`
|
|
|
|
[[delete-snapshot-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage`
|
|
<<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[delete-snapshot-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<repository>`::
|
|
(Required, string)
|
|
Name of the repository to delete a snapshot from.
|
|
|
|
`<snapshot>`::
|
|
(Required, string)
|
|
Comma-separated list of snapshot names to delete. Also accepts wildcards (`*`).
|
|
|
|
[[delete-snapshot-api-example]]
|
|
==== {api-example-title}
|
|
|
|
The following request deletes `snapshot_2` and `snapshot_3` from the repository named `my_repository`.
|
|
|
|
[source,console]
|
|
----
|
|
DELETE /_snapshot/my_repository/snapshot_2,snapshot_3
|
|
----
|
|
|
|
The API returns the following response:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"acknowledged" : true
|
|
}
|
|
----
|