Browse Source

Docs: Provide example of deleting a repository

Example of deleting a repository with explanation that snapshots themselves are left untouched.

Closes #8172
Peter Dyson 11 years ago
parent
commit
b984cb771f
1 changed files with 9 additions and 0 deletions
  1. 9 0
      docs/reference/modules/snapshots.asciidoc

+ 9 - 0
docs/reference/modules/snapshots.asciidoc

@@ -191,6 +191,15 @@ created the snapshotting process will be aborted and all files created as part o
 cleaned. Therefore, the delete snapshot operation can be used to cancel long running snapshot operations that were
 started by mistake.
 
+A repository can be deleted using the following command:
+
+[source,shell]
+-----------------------------------
+$ curl -XDELETE "localhost:9200/_snapshot/my_backup"
+-----------------------------------
+
+When a repository is deleted, Elasticsearch only removes the reference to the location where the repository is storing
+the snapshots. The snapshots themselves are left untouched and in place.
 
 [float]
 === Restore