cat templates APIedit

Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation.

Requestedit

GET /_cat/templates/<template_name>

Path parametersedit

<template_name>
(Optional, string) Comma-separated list of index template names used to limit the request. Accepts wildcard expressions.

Query parametersedit

format
(Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
h
(Optional, string) Comma-separated list of column names to display.
help
(Optional, boolean) If true, the response returns help information. 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.
s
(Optional, string) Comma-separated list of column names or column aliases used to sort the response.
v
(Optional, boolean) If true, the response includes column headings. Defaults to false.

Examplesedit

GET /_cat/templates?v&s=name

The API returns the following response:

name      index_patterns order version
template0 [te*]          0
template1 [tea*]         1
template2 [teak*]        2     7