You're viewing version 2.16 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
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
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:
| Parameter | Type | Description |
|---|---|---|
| local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is false. |
| expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are all, open, closed, hidden, and none. Default is open. |
Example requests
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
Example 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 | * | - | - | -
.opensearch-dashboards | .opensearch-dashboards_1 | - | - | - | -
To learn more about index aliases, see Index aliases.