Check existence of index templates

HEAD /_template/{name}

Get information about whether index templates exist. Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

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

Read the reference documentation

Path Parameters

name union Name | [] Name required: A comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

Query Parameters

Response

200 application/json

Examples

Request Console 1 / 8 languages

Console Kibana Dev Tools

HEAD /_template/template_1

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

resp = client.indices.exists_template(
    name="template_1",
)

curl Shell

curl "$ELASTICSEARCH_URL/_template/template_1" \
  --head \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.indices().existsTemplate(e -> e
    .name("template_1")
);

C# Elasticsearch .NET Client

var response = await client.Indices.ExistsTemplateAsync(name: new[] { "template_1" });

PHP Elasticsearch PHP Client

$resp = $client->indices()->existsTemplate([
    "name" => "template_1",
]);

Ruby Elasticsearch Ruby Client

response = client.indices.exists_template(
  name: "template_1"
)

Response

No example

Required authorization

Path Parameters

Query Parameters { flat_settings , local , master_timeout , }

Response

Query Parameters