IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get index template API
editGet index template API
editThis 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, Index templates .
Retrieves information about one or more index templates.
GET /_template/template_1
Request
editGET /_template/<index-template>
Path parameters
edit-
<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
_all
or*
.
Query parameters
edit-
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) Specifies the period of time 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
.