123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869 |
- [[indices-alias-exists]]
- === Index alias exists API
- ++++
- <titleabbrev>Index alias exists</titleabbrev>
- ++++
- Checks if an index alias exists.
- include::{docdir}/glossary.asciidoc[tag=index-alias-desc]
- [source,console]
- ----
- HEAD /_alias/alias1
- ----
- // TEST[setup:twitter]
- // TEST[s/^/PUT twitter\/_alias\/alias1\n/]
- [[alias-exists-api-request]]
- ==== {api-request-title}
- `HEAD /_alias/<alias>`
- `HEAD /<index>/_alias/<alias>`
- [[alias-exists-api-path-params]]
- ==== {api-path-parms-title}
- `<alias>`::
- (Required, string)
- include::{docdir}/rest-api/common-parms.asciidoc[tag=index-alias]
- include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
- [[alias-exists-api-query-params]]
- ==== {api-query-parms-title}
- include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
- include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
- +
- Defaults to `all`.
- include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
- include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
- [[alias-exists-api-response-codes]]
- ==== {api-response-codes-title}
- `200`::
- Indicates all specified index aliases exist.
- `404`::
- Indicates one or more specified index aliases **do not** exist.
- [[alias-exists-api-example]]
- ==== {api-examples-title}
- [source,console]
- ----
- HEAD /_alias/2030
- HEAD /_alias/20*
- HEAD /logs_20302801/_alias/*
- ----
- // TEST[s/^/PUT logs_20302801\nPUT logs_20302801\/_alias\/2030\n/]
|