Skip to content

Commit

Permalink
[7.8] [DOCS] Adding delete snapshot API docs. (#58865) (#58876)
Browse files Browse the repository at this point in the history
* [DOCS] Adding delete snapshot API docs.

* Adding TESTSETUP snippets and fixing original TEST.

* Removing extraneous TESTSETUP.

* Revising <snapshot> description.

* Removing TEST.

* Streamline delete API description.

* Improve TESTSETUP for snippets.
  • Loading branch information
Adam Locke authored Jul 1, 2020
1 parent 99f7898 commit a9c2115
Show file tree
Hide file tree
Showing 2 changed files with 89 additions and 8 deletions.
80 changes: 80 additions & 0 deletions docs/reference/snapshot-restore/apis/delete-snapshot-api.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
[[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-desc]]
==== {api-description-title}

Use the delete snapshot API to delete a <<snapshot-restore,snapshot>>, which is a backup taken from a running {es} cluster.

When deleting a snapshot from a repository, {es} deletes all files that are associated with the snapshot and not used by any other snapshots. All files that are shared with at least one other existing snapshot are left intact.

If you attempt to delete a snapshot while it is being created, the snapshot process aborts and all associated will be deleted.

To delete multiple snapshots in a single request, separate the snapshot names with a comma or use a wildcard (`*`).

TIP: Use the delete snapshot API to cancel long-running snapshot operations that were started by mistake.

[[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
}
----
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,22 @@ content may not be included yet.
[discrete]
[[snapshot-restore-repo-apis]]
=== Snapshot repository management APIs

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

[discrete]
[[snapshot-management-apis]]
=== Snapshot management APIs
* <<create-snapshot-api,Create snapshot>>
* <<delete-snapshot-api,Delete snapshot>>

include::create-snapshot-api.asciidoc[]
include::clean-up-repo-api.asciidoc[]
include::delete-repo-api.asciidoc[]
include::get-repo-api.asciidoc[]
include::put-repo-api.asciidoc[]
include::verify-repo-api.asciidoc[]
include::get-repo-api.asciidoc[]
include::delete-repo-api.asciidoc[]
include::clean-up-repo-api.asciidoc[]
include::create-snapshot-api.asciidoc[]
include::delete-snapshot-api.asciidoc[]

0 comments on commit a9c2115

Please sign in to comment.