Get index template API

Get index template API

Returns information about one or more index templates.

  1. GET /_index_template/template_1

Request

GET /_index_template/<index-template>

Prerequisites

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

Path parameters

(Optional, string) The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned.

Query parameters

flat_settings

(Optional, Boolean) If true, returns settings in flat format. Defaults to false.

include_type_name

[7.0.0] Deprecated in 7.0.0. Mapping types have been deprecated. See Removal of mapping types. (Optional, boolean) If true, a mapping type is expected in the body of mappings. 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 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.

Examples

Get index templates using a wildcard expression

  1. GET /_index_template/temp*

Get all index templates

  1. GET /_index_template