Get legacy index templates

deprecated

GET /_template/{name}
GET /_template

Get information about one or more index templates.

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

Required authorization

Cluster privileges: manage_index_templates

Learn more about templates

Path Parameters

name union Name | [] Name optional

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

Leave it out to use /_template.

Query Parameters

Response

application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /_template/.monitoring-*

JavaScript Elasticsearch JavaScript Client

const response = await client.indices.getTemplate({
  name: ".monitoring-*",
});

Python Elasticsearch Python Client

resp = client.indices.get_template(
    name=".monitoring-*",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_template/.monitoring-*" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().getTemplate(g -> g
    .name(".monitoring-*")
);

C# Elasticsearch .NET Client

var response = await client.Indices
    .GetTemplateAsync(d1 => d1
        .Name(new[] { ".monitoring-*" })
    );

PHP Elasticsearch PHP Client

$resp = $client->indices()->getTemplate([
    "name" => ".monitoring-*",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.get_template(
  name: ".monitoring-*"
)

Response

No example

Required authorization

Path Parameters

Query Parameters { flat_settings , local , master_timeout , }

Response

Query Parameters