CAT aliases

Introduced 1.0

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

Path and HTTP methods

  1. GET _cat/aliases/<alias>
  2. 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 cluster manager 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.

Example requests

  1. GET _cat/aliases?v

copy

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

  1. GET _cat/aliases/<alias>?v

copy

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

  1. GET _cat/aliases/alias1,alias2,alias3

copy

Example response

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

  1. alias   | index     | filter  | routing.index | routing.search  | is_write_index
  2. alias1  | movies    |   *     |      -        |       -         |      -
  3. .opensearch-dashboards | .opensearch-dashboards_1 |   -     |      -        |       -         |      -

To learn more about index aliases, see Index aliases.