Get aliases

GET /_cat/aliases/{name}

Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases.

CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

Path parameters

  • name string | array[string] Required

    A comma-separated list of aliases to retrieve. Supports wildcards (*). To retrieve all aliases, omit this parameter or use * or _all.

Query parameters

  • expand_wildcards string | array[string]

    Whether to expand wildcard expression to concrete indices that are open, closed or both.

  • master_timeout string

    Period to wait for a connection to the master node.

Responses

GET /_cat/aliases/{name} 
curl \
 -X GET http://api.example.com/_cat/aliases/{name}