Index alias exists API

edit

Checks if an index alias exists.

An index alias is a secondary name used to refer to one or more existing indices.

Most Elasticsearch APIs accept an index alias in place of an index name.

HEAD /_alias/alias1

Request

edit

HEAD /_alias/<alias>

HEAD /<index>/_alias/<alias>

Prerequisites

edit
  • 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 parameters

edit
<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 parameters

edit
expand_wildcards

(Optional, string) Controls what kind of indices that wildcard expressions can expand to. Multiple values are accepted when separated by a comma, as in open,hidden. Valid values are:

all
Expand to open and closed indices, including hidden indices.
open
Expand only to open indices.
closed
Expand only to closed indices.
hidden
Expansion of wildcards will include hidden indices. Must be combined with open, closed, or both.
none
Wildcard expressions are not accepted.

Defaults to all.

ignore_unavailable
(Optional, Boolean) If false, the request returns an error if it targets a missing or closed index. 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 codes

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

Examples

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