A newer version is available. For the latest information, see the
current release documentation.
Get index template API edit
Returns information about one or more index templates.
GET /_index_template/template_1
Requestedit
GET /_index_template/<index-template>
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_index_templates
ormanage
cluster privilege to use this API.
Path parametersedit
(Optional, string) The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.
Query parametersedit
-
flat_settings
-
(Optional, Boolean) If
true
, returns settings in flat format. Defaults tofalse
. -
include_type_name
-
[7.0.0]
Deprecated in 7.0.0. Mapping types have been deprecated. See Removal of mapping types.
(Optional, boolean) If
true
, a mapping type is expected in the body of mappings. 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
.