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>

GET /_cat/templates

Prerequisitesedit

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

Path parametersedit

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

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 includes 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) 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.
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/my-template-*?v=true&s=name

The API returns the following response:

name          index_patterns order version composed_of
my-template-0 [te*]          500           []
my-template-1 [tea*]         501           []
my-template-2 [teak*]        502   7       []