Get component templates Added in 5.1.0
Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
Path parameters
-
The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.
Query parameters
-
h string | array[string]
List of columns to appear in the response. Supports simple wildcards.
-
s string | array[string]
List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting
:asc
or:desc
as a suffix to the column name. -
local boolean
If
true
, the request computes the list of selected nodes from the local cluster state. Iffalse
the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. -
master_timeout string
The period to wait for a connection to the master node.
curl \
--request GET http://api.example.com/_cat/component_templates/{name} \
--header "Authorization: $API_KEY"
[
{
"name": "string",
"version": "string",
"alias_count": "string",
"mapping_count": "string",
"settings_count": "string",
"metadata_count": "string",
"included_in": "string"
}
]
alias index filter routing.index routing.search is_write_index
alias1 test1 - - - -
alias2 test1 * - - -
alias3 test1 - 1 1 -
alias4 test1 - 2 1,2 -