|
| 1 | +[[delete-snapshot-repo-api]] |
| 2 | +=== Delete snapshot repository API |
| 3 | +++++ |
| 4 | +<titleabbrev>Delete snapshot repository</titleabbrev> |
| 5 | +++++ |
| 6 | + |
| 7 | +Unregisters one or more <<snapshots-register-repository,snapshot repositories>>. |
| 8 | + |
| 9 | +When a repository is unregistered, {es} only removes the reference to the |
| 10 | +location where the repository is storing the snapshots. The snapshots themselves |
| 11 | +are left untouched and in place. |
| 12 | + |
| 13 | +//// |
| 14 | +[source,console] |
| 15 | +---- |
| 16 | +PUT /_snapshot/my_repository |
| 17 | +{ |
| 18 | + "type": "fs", |
| 19 | + "settings": { |
| 20 | + "location": "my_backup_location" |
| 21 | + } |
| 22 | +} |
| 23 | +---- |
| 24 | +//// |
| 25 | + |
| 26 | +[source,console] |
| 27 | +---- |
| 28 | +DELETE /_snapshot/my_repository |
| 29 | +---- |
| 30 | +// TEST[continued] |
| 31 | + |
| 32 | +[[delete-snapshot-repo-api-request]] |
| 33 | +==== {api-request-title} |
| 34 | + |
| 35 | +`DELETE /_snapshot/<repository>` |
| 36 | + |
| 37 | +[[delete-snapshot-repo-api-path-params]] |
| 38 | +==== {api-path-parms-title} |
| 39 | + |
| 40 | +`<repository>`:: |
| 41 | +(Required, string) |
| 42 | +Name of the snapshot repository to unregister. Wildcard (`*`) patterns are |
| 43 | +supported. |
| 44 | + |
| 45 | +[[delete-snapshot-repo-api-query-params]] |
| 46 | +==== {api-query-parms-title} |
| 47 | + |
| 48 | +`master_timeout`:: |
| 49 | +(Optional, <<time-units, time units>>) Specifies the period of time to wait for |
| 50 | +a connection to the master node. If no response is received before the timeout |
| 51 | +expires, the request fails and returns an error. Defaults to `30s`. |
| 52 | + |
| 53 | +`timeout`:: |
| 54 | +(Optional, <<time-units, time units>>) Specifies the period of time to wait for |
| 55 | +a response. If no response is received before the timeout expires, the request |
| 56 | +fails and returns an error. Defaults to `30s`. |
0 commit comments