Get index template API edit

Returns information about one or more index templates.

response = client.indices.get_index_template(
  name: 'template_1'
puts response
GET /_index_template/template_1


GET /_index_template/<index-template>


  • If the Elasticsearch security features are enabled, you must have the manage_index_templates or manage cluster privilege to use this API, or the monitor cluster privilege to retrieve templates.

Path parametersedit

(Optional, string) The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

Query parametersedit

(Optional, Boolean) If true, returns settings in flat format. Defaults to false.
(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.
(Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.
(Optional, Boolean) Functionality in [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. . If true, return all default settings in the response. Defaults to false.


Get index templates using a wildcard expressionedit

response = client.indices.get_index_template(
  name: 'temp*'
puts response
GET /_index_template/temp*

Get all index templatesedit

response = client.indices.get_index_template
puts response
GET /_index_template