You're viewing version 2.18 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.
Endpoints
GET /_cat/aliases
GET /_cat/aliases/{name}
Query parameters
The following table lists the available query parameters. All query parameters are optional.
| Parameter | Data type | Description | Default |
|---|---|---|---|
expand_wildcards | List or String | Specifies the type of index that wildcard expressions can match. Supports comma-separated values. Valid values are: - all: Match any index, including hidden ones. - closed: Match closed, non-hidden indexes. - hidden: Match hidden indexes. Must be combined with open, closed, or both. - none: Wildcard expressions are not accepted. - open: Match open, non-hidden indexes. | N/A |
format | String | A short version of the Accept header, such as json or yaml. | N/A |
h | List | A comma-separated list of column names to display. | N/A |
help | Boolean | Returns help information. | false |
local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. | false |
s | List | A comma-separated list of column names or column aliases to sort by. | N/A |
v | Boolean | Enables verbose mode, which displays column headers. | false |
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.