alias-exists.asciidoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. [[indices-alias-exists]]
  2. === Index alias exists API
  3. ++++
  4. <titleabbrev>Index alias exists</titleabbrev>
  5. ++++
  6. Checks if an index alias exists.
  7. include::{docdir}/glossary.asciidoc[tag=index-alias-desc]
  8. [source,console]
  9. ----
  10. HEAD /_alias/alias1
  11. ----
  12. // TEST[setup:twitter]
  13. // TEST[s/^/PUT twitter\/_alias\/alias1\n/]
  14. [[alias-exists-api-request]]
  15. ==== {api-request-title}
  16. `HEAD /_alias/<alias>`
  17. `HEAD /<index>/_alias/<alias>`
  18. [[alias-exists-api-path-params]]
  19. ==== {api-path-parms-title}
  20. `<alias>`::
  21. (Required, string)
  22. include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias]
  23. include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
  24. [[alias-exists-api-query-params]]
  25. ==== {api-query-parms-title}
  26. include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
  27. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
  28. +
  29. Defaults to `all`.
  30. include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
  31. include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
  32. [[alias-exists-api-response-codes]]
  33. ==== {api-response-codes-title}
  34. `200`::
  35. Indicates all specified index aliases exist.
  36. `404`::
  37. Indicates one or more specified index aliases **do not** exist.
  38. [[alias-exists-api-example]]
  39. ==== {api-examples-title}
  40. [source,console]
  41. ----
  42. HEAD /_alias/2030
  43. HEAD /_alias/20*
  44. HEAD /logs_20302801/_alias/*
  45. ----
  46. // TEST[s/^/PUT logs_20302801\nPUT logs_20302801\/_alias\/2030\n/]