delete-alias.asciidoc 989 B

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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::{docdir}/glossary.asciidoc[tag=index-alias-desc]
  8. [source,console]
  9. ----
  10. DELETE /twitter/_alias/alias1
  11. ----
  12. // TEST[setup:twitter]
  13. // TEST[s/^/PUT twitter\/_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-path-params]]
  19. ==== {api-path-parms-title}
  20. `<index>`::
  21. (Required, string)
  22. Comma-separated list or wildcard expression of index names
  23. used to limit the request.
  24. +
  25. To include all indices in the cluster,
  26. use a value of `_all` or `*`.
  27. `<alias>`::
  28. (Required, string)
  29. include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias]
  30. +
  31. To delete all aliases,
  32. use a value of `_all` or `*`.
  33. [[delete-alias-api-query-params]]
  34. ==== {api-query-parms-title}
  35. include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]