dangling-index-delete.asciidoc 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. [[dangling-index-delete]]
  2. === Delete dangling index API
  3. ++++
  4. <titleabbrev>Delete dangling index</titleabbrev>
  5. ++++
  6. Deletes a dangling index.
  7. [[dangling-index-delete-api-request]]
  8. ==== {api-request-title}
  9. [source,console]
  10. --------------------------------------------------
  11. DELETE /_dangling/<index-uuid>?accept_data_loss=true
  12. --------------------------------------------------
  13. // TEST[skip:Difficult to set up]
  14. [[dangling-index-delete-api-prereqs]]
  15. ==== {api-prereq-title}
  16. * If the {es} {security-features} are enabled, you must have the `manage`
  17. <<privileges-list-cluster,cluster privilege>> to use this API.
  18. [[dangling-index-delete-api-desc]]
  19. ==== {api-description-title}
  20. include::{es-repo-dir}/indices/dangling-indices-list.asciidoc[tag=dangling-index-description]
  21. Deletes a dangling index by referencing its UUID. Use the
  22. <<dangling-indices-list,List dangling indices API>> to locate the UUID of an index.
  23. [[dangling-index-delete-api-path-params]]
  24. ==== {api-path-parms-title}
  25. `<index-uuid>`::
  26. (Required, string)
  27. UUID of the index to delete. You can find this using the
  28. <<dangling-indices-list,List dangling indices API>>.
  29. [[dangling-index-delete-api-query-params]]
  30. ==== {api-query-parms-title}
  31. `accept_data_loss`::
  32. (Optional, Boolean)
  33. This field must be set to `true` in order to carry out the import, since it will
  34. no longer be possible to recover the data from the dangling index.
  35. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]