IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Index template exists API
editIndex template exists API
editThis documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. For information about composable templates, see Index templates.
Checks if an legacy index template exists.
response = client.indices.exists_template( name: 'template_1' ) puts response
HEAD /_template/template_1
Request
editHEAD /_template/<index-template>
Prerequisites
edit-
If the Elasticsearch security features are enabled, you must have the
manage_index_templates
ormanage
cluster privilege to use this API.
Description
editUse 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 tofalse
. -
local
-
(Optional, Boolean) If
true
, the request retrieves information from the local node only. Defaults tofalse
, which means information is retrieved from the master node. -
master_timeout
-
(Optional, time units)
Period 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.