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.

Learn more about templates

Required authorization

Authentication

Api key

Authorization: <value>

Elasticsearch APIs support key-based authentication. You must create an API key and use the encoded value in the request header. For example:

		curl -X GET "${ES_URL}/_cat/indices?v=true" \
  -H "Authorization: ApiKey ${API_KEY}"

To get API keys, use the /_security/api_key APIs.

Basic

Authorization: Basic <credentials>

Bearer

Authorization: Bearer <token>

Elasticsearch APIs support the use of bearer tokens in the Authorization HTTP header to authenticate with the API. For examples, refer to Token-based authentication services

Path parameters

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