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 Get mapping API »

› › ›

Get index template API

edit

Get index template API

edit

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.

response = client.indices.get_template(
  name: 'template_1'
)
puts response

GET /_template/template_1

Request

edit

GET /_template/<index-template>

Prerequisites

edit

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

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 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) 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.

Examples

edit

Get multiple index templates

edit

response = client.indices.get_template(
  name: 'template_1,template_2'
)
puts response

GET /_template/template_1,template_2

Get index templates using a wildcard expression

edit

response = client.indices.get_template(
  name: 'temp*'
)
puts response

GET /_template/temp*

Get all index templates

edit

response = client.indices.get_template
puts response

GET /_template

« Get index template API Get mapping API »