Check aliases

HEAD /{index}/_alias/{name}

Copy endpoint

Check if one or more data stream or index aliases exist.

Parameters

path Path Parameters

Name	Type
`index` required 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`.	type TypesIndices = type TypesIndexName = string \| type TypesIndexName = string[]
`name` required Comma-separated list of aliases to check. Supports wildcards (`*`).	type TypesNames = type TypesName = string \| type TypesName = string[]

query Query Parameters

Name	Type
`allow_no_indices` 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.	boolean
`expand_wildcards` 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`.	type TypesExpandWildcards = type TypesExpandWildcard = "all" \| "open" \| "closed" \| "hidden" \| "none" \| type TypesExpandWildcard = "all" \| "open" \| "closed" \| "hidden" \| "none"[]
`ignore_unavailable` If `false`, requests that include a missing data stream or index in the target indices or data streams return an error.	boolean
`master_timeout` Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.	type TypesDuration = string \| "-1" \| "0"

Responses

200 application/json

unknown