IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Index alias exists API
editIndex alias exists API
editChecks 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
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
view_index_metadata
ormanage
index privilege for the index alias. If you specify an index, you must also haveview_index_metadata
ormanage
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) 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
false
, the request returns an error if it targets a missing or closed index. Defaults tofalse
. -
local
-
(Optional, Boolean) If
true
, the request retrieves information from the local node only. Defaults tofalse
, 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
editHEAD /_alias/2030 HEAD /_alias/20* HEAD /logs_20302801/_alias/*