IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Index stats API Open index API »
Elastic Docs ›Elasticsearch Guide [7.9] ›REST APIs ›Index APIs

Index template exists API

edit

Index template exists API

edit

Checks if an index template exists.

HEAD /_template/template_1

Request

edit

HEAD /_template/<index-template>

Description

edit

Use the index template exists API to determine whether one or more index templates exist.

Index templates define settings, mappings, and aliases that can be applied automatically to new indices.

Path parameters

edit
<index-template>
(Required, string) Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported.

Query parameters

edit
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) Specifies the period of time to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Defaults to 30s.

Response codes

edit
200
Indicates all specified index templates exist.
404
Indicates one or more specified index templates do not exist.
« Index stats API Open index API »