New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
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 settings API Get mapping API »
Elastic Docs ›Elasticsearch Guide [7.4] ›REST APIs ›Index APIs

Get index template API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get index template API

edit

Returns information about one or more index templates.

GET /_template/template_1
Copy as curlTry in Elastic 

Request

edit

GET /_template/<index-template>

Path parameters

edit
<index-template>

(Required, string) Comma-separated list or wildcard expression of index template names used to limit the request.

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 to false.
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 to false.
local
(Optional, boolean) If true, the request retrieves information from the local node only. Defaults to false, 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.

Examples

edit

Get multiple index templates

edit
GET /_template/template_1,template_2
Copy as curlTry in Elastic 

Get index templates using a wildcard expression

edit
GET /_template/temp*
Copy as curlTry in Elastic 

Get all index templates

edit
GET /_template
Copy as curlTry in Elastic 
« Get index settings API Get mapping API »
Was this helpful?
Feedback