cat aliases APIedit

Returns information about currently configured aliases to indices, including filter and routing information.


GET /_cat/aliases/<alias>

GET /_cat/aliases

Path parametersedit

(Optional, string) Comma-separated list or wildcard expression of index alias names used to limit the request.

Query parametersedit

(Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
(Optional, string) Comma-separated list of column names to display.
(Optional, boolean) If true, the response includes help information. Defaults to false.
(Optional, boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
(Optional, string) Comma-separated list of column names or column aliases used to sort the response.
(Optional, boolean) If true, the response includes column headings. Defaults to false.


GET /_cat/aliases?v

The API returns the following response:

alias  index filter routing.index is_write_index
alias1 test1 -      -            -              -
alias2 test1 *      -            -              -
alias3 test1 -      1            1              -
alias4 test1 -      2            1,2            -

This response shows that alias2 has configured a filter, and specific routing configurations in alias3 and alias4.

If you only want to get information about specific aliases, you can specify the aliases in comma-delimited format as a URL parameter, e.g., /_cat/aliases/alias1,alias2.