delete-alias.asciidoc 989 B

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