Get index templates

GET /_index_template/{name}
GET /_index_template

Api key auth Basic auth Bearer auth

Get information about one or more index templates.

Required authorization

Cluster privileges: manage_index_templates

Path Parameters

name string Name optional

Name of index template to retrieve. Wildcard (*) expressions are supported.

Leave it out to use /_index_template.

Query Parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getIndexTemplate({
  name: "*",
  filter_path:
    "index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream",
});

Python Elasticsearch Python Client

resp = client.indices.get_index_template(
    name="*",
    filter_path="index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

C# Elasticsearch .NET Client

var response = await client.Indices
    .GetIndexTemplateAsync(d1 => d1
        .Name("*")
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->getIndexTemplate([
    "name" => "*",
    "filter_path" => "index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_index_template(
  name: "*",
  filter_path: "index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream"
)

Response

No example

Required authorization

Path Parameters

Query Parameters { local , flat_settings , master_timeout , include_defaults , }

Response

Query Parameters