Get aliases

GET /{index}/_alias/{name}
GET /{index}/_alias
GET /_alias/{name}
GET /_alias

Auth

Retrieves information for one or more data stream or index aliases.

Required privileges

Index privileges view_index_metadata

Path parameters

index union string | string[] optional

Comma-separated list of data streams or indices used to limit the request. Supports wildcards (*). To target all data streams and indices, omit this parameter or use * or _all.

Leave it out to use /_alias.

name union string | string[] optional

Comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

Leave it out to use /_alias.

Query parameters

allow_no_indices boolean · default: true

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices.

expand_wildcards union oneOf · default: all

Type of index that wildcard patterns 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.

Supported values include:

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.

Values: all open closed hidden none

ignore_unavailable boolean · default: false

If false, the request returns an error if it targets a missing or closed index.

local boolean · default: false deprecated

If true, the request retrieves information from the local node only.

Responses

application/json

<string> object

application/json