Skip to main content
Version: 0.13.0

CAT aliases

Introduced 0.1.0

The CAT aliases operation lists the mapping of aliases to indexes, plus routing and filtering information.

Example​

GET _cat/aliases?v

To limit the information to a specific alias, add the alias name after your query:

GET _cat/aliases/<alias>?v

If you want to get information for more than one alias, separate the alias names with commas:

GET _cat/aliases/alias1,alias2,alias3

Path and HTTP methods​

GET _cat/aliases/<alias>
GET _cat/aliases

URL parameters​

All CAT aliases URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

ParameterTypeDescription
localBooleanWhether to return information from the local node only instead of from the master node. Default is false.
expand_wildcardsEnumExpands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are all, open, closed, hidden, and none. Default is open.

Response​

The following response shows that alias1 refers to a movies index and has a configured filter:

alias   | index     | filter  | routing.index | routing.search  | is_write_index
alias1 | movies | * | - | - | -

To learn more about index aliases, see Index aliases.