delete-alias.asciidoc 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. [[indices-delete-alias]]
  2. === Delete index alias API
  3. ++++
  4. <titleabbrev>Delete index alias</titleabbrev>
  5. ++++
  6. Deletes an existing index alias.
  7. include::{es-repo-dir}/indices/add-alias.asciidoc[tag=index-alias-desc]
  8. [source,console]
  9. ----
  10. DELETE /my-index-000001/_alias/alias1
  11. ----
  12. // TEST[setup:my_index]
  13. // TEST[s/^/PUT my-index-000001\/_alias\/alias1\n/]
  14. [[delete-alias-api-request]]
  15. ==== {api-request-title}
  16. `DELETE /<index>/_alias/<alias>`
  17. `DELETE /<index>/_aliases/<alias>`
  18. [[delete-alias-api-prereqs]]
  19. ==== {api-prereq-title}
  20. * If the {es} {security-features} are enabled, you must have the `manage`
  21. <<privileges-list-indices,index privilege>> for both the index and index alias.
  22. [[delete-alias-api-path-params]]
  23. ==== {api-path-parms-title}
  24. `<index>`::
  25. (Required, string)
  26. Comma-separated list or wildcard expression of index names
  27. used to limit the request.
  28. +
  29. To include all indices in the cluster,
  30. use a value of `_all` or `*`.
  31. `<alias>`::
  32. (Required, string)
  33. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias]
  34. +
  35. To delete all aliases,
  36. use a value of `_all` or `*`.
  37. [[delete-alias-api-query-params]]
  38. ==== {api-query-parms-title}
  39. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]