Index template exists API

Checks if an index template exists.

  1. HEAD /_template/template_1

Request

HEAD /_template/<index-template>

Description

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

<index-template>

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

Query parameters

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

200

Indicates all specified index templates exist.

404

Indicates one or more specified index templates do not exist.