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 List dangling indices API »

› › ›

Index template exists API

edit

Index template exists API

edit

This 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

edit

HEAD /_template/<index-template>

Prerequisites

edit

If the Elasticsearch security features are enabled, you must have the manage_index_templates or manage cluster privilege to use this API.

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) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

Response codes

edit

200: Indicates all specified index templates exist.
404: Indicates one or more specified index templates do not exist.

« Index stats API List dangling indices API »