delete-alias.asciidoc 1.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. [[indices-delete-alias]]
  2. === Delete alias API
  3. ++++
  4. <titleabbrev>Delete alias</titleabbrev>
  5. ++++
  6. Removes a data stream or index from an <<aliases,alias>>.
  7. [source,console]
  8. ----
  9. DELETE my-data-stream/_alias/my-alias
  10. ----
  11. // TEST[setup:my_data_stream]
  12. // TEST[s/^/PUT my-data-stream\/_alias\/my-alias\n/]
  13. // TEST[teardown:data_stream_cleanup]
  14. [[delete-alias-api-request]]
  15. ==== {api-request-title}
  16. `DELETE <target>/_alias/<alias>`
  17. `DELETE <target>/_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 the alias and it data streams or
  22. indices.
  23. [[delete-alias-api-path-params]]
  24. ==== {api-path-parms-title}
  25. `<alias>`::
  26. (Required, string) Comma-separated list of aliases to remove. Supports wildcards
  27. (`*`). To remove all aliases, use `*` or `_all`.
  28. `<target>`::
  29. (Required, string) Comma-separated list of data streams or indices used to limit
  30. the request. Supports wildcards (`*`).
  31. [[delete-alias-api-query-params]]
  32. ==== {api-query-parms-title}
  33. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]