IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
cat aliases API
editcat aliases API
editReturns information about currently configured aliases to indices, including filter and routing information.
Path parameters
edit-
<alias>
- (Optional, string) Comma-separated list or wildcard expression of index alias names used to limit the request.
Query parameters
edit-
format
- (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
h
- (Optional, string) Comma-separated list of column names to display.
-
help
-
(Optional, boolean) If
true
, the response includes help information. Defaults tofalse
. -
local
-
(Optional, boolean) If
true
, the request retrieves information from the local node only. Defaults tofalse
, which means information is retrieved from the master node. -
s
- (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
v
-
(Optional, boolean) If
true
, the response includes column headings. Defaults tofalse
.
Examples
editGET /_cat/aliases?v
The API returns the following response:
alias index filter routing.index routing.search 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.