Get index template API

Get index template API

New API reference

For the most up-to-date API details, refer to Index APIs.

Returns information about one or more index templates.

resp = client.indices.get_index_template(
    name="template_1",
)
print(resp)

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

const response = await client.indices.getIndexTemplate({
  name: "template_1",
});
console.log(response);

GET /_index_template/template_1

Request

GET /_index_template/<index-template>

Prerequisites

• 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 parameters

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

Query parameters

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.

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.

Examples

Get index templates using a wildcard expression

resp = client.indices.get_index_template(
    name="temp*",
)
print(resp)

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

const response = await client.indices.getIndexTemplate({
  name: "temp*",
});
console.log(response);

GET /_index_template/temp*

Get all index templates

resp = client.indices.get_index_template()
print(resp)

response = client.indices.get_index_template
puts response

const response = await client.indices.getIndexTemplate();
console.log(response);

GET /_index_template