Get index template API | Elasticsearch Guide [8.13]

› › ›

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.

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

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 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.
include_defaults: (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.

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

GET /_index_template/temp*

response = client.indices.get_index_template
puts response

GET /_index_template