Get index template APIedit
This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. For information about composable templates, see Index templates.
Retrieves information about one or more index templates.
GET /_template/template_1
Requestedit
GET /_template/<index-template>
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_index_templatesormanagecluster privilege to use this API.
Path parametersedit
-
<index-template> -
(Required, string) Comma-separated list of index template names used to limit the request. Wildcard (
*) expressions are supported.To return all index templates, omit this parameter or use a value of
_allor*.
Query parametersedit
-
flat_settings -
(Optional, Boolean) If
true, returns settings in flat format. 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. -
master_timeout -
(Optional, time units)
Period to wait for a connection to the master node. If no response is received
before the timeout expires, the request fails and returns an error. Defaults to
30s.