elasticsearch/docs/reference/indices/dangling-index-delete.asciidoc
Liam Thompson 33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00

50 lines
1.4 KiB
Text

[[dangling-index-delete]]
=== Delete dangling index API
++++
<titleabbrev>Delete dangling index</titleabbrev>
++++
Deletes a dangling index.
[[dangling-index-delete-api-request]]
==== {api-request-title}
[source,console]
--------------------------------------------------
DELETE /_dangling/<index-uuid>?accept_data_loss=true
--------------------------------------------------
// TEST[skip:Difficult to set up]
[[dangling-index-delete-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.
[[dangling-index-delete-api-desc]]
==== {api-description-title}
include::{es-ref-dir}/indices/dangling-indices-list.asciidoc[tag=dangling-index-description]
Deletes a dangling index by referencing its UUID. Use the
<<dangling-indices-list,List dangling indices API>> to locate the UUID of an index.
[[dangling-index-delete-api-path-params]]
==== {api-path-parms-title}
`<index-uuid>`::
(Required, string)
UUID of the index to delete. You can find this using the
<<dangling-indices-list,List dangling indices API>>.
[[dangling-index-delete-api-query-params]]
==== {api-query-parms-title}
`accept_data_loss`::
(Optional, Boolean)
This field must be set to `true` in order to carry out the import, since it will
no longer be possible to recover the data from the dangling index.
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]