Index alias exists APIedit

Checks if an index alias exists.

An index alias is a secondary name for one or more indices. Most Elasticsearch APIs accept an index alias in place of an index name.

HEAD /_alias/alias1

Requestedit

HEAD /_alias/<alias>

HEAD /<index>/_alias/<alias>

Prerequisitesedit

  • If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the index alias. If you specify an index, you must also have view_index_metadata or manage index privilege for the index.

Path parametersedit

<alias>
(Required, string) Comma-separated list or wildcard expression of index alias names used to limit the request.
<index>
(Optional, string) Comma-separated list or wildcard expression of index names used to limit the request.

Query parametersedit

expand_wildcards

(Optional, string) Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. Valid values are:

all
Match any data stream or index, including hidden ones.
open
Match open, non-hidden indices. Also matches any non-hidden data stream.
closed
Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
hidden
Match hidden data streams and hidden indices. Must be combined with open, closed, or both.
none
Wildcard expressions are not accepted.

Defaults to all.

ignore_unavailable
(Optional, Boolean) If true, missing or closed indices are not included in the response. Defaults to false.
local
(Optional, Boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

Response codesedit

200
Indicates all specified index aliases exist.
404
Indicates one or more specified index aliases do not exist.

Examplesedit

HEAD /_alias/2030
HEAD /_alias/20*
HEAD /logs_20302801/_alias/*