elasticsearch/docs/reference/cat/templates.asciidoc

[[cat-templates]]
=== cat templates API
++++
<titleabbrev>cat templates</titleabbrev>
++++

.New API reference
[sidebar]
--
For the most up-to-date API details, refer to {api-es}/group/endpoint-cat[Compact and aligned text (CAT) APIs]..
--

[IMPORTANT]
====
cat APIs are only intended for human consumption using the command line or {kib} 
console. They are _not_ intended for use by applications. For application 
consumption, use the <<indices-get-template,get index template API>>.
====

Returns information about <<index-templates,index templates>> in a cluster.
You can use index templates to apply <<index-modules-settings,index settings>>
and <<mapping,field mappings>> to new indices at creation.


[[cat-templates-api-request]]
==== {api-request-title}

`GET /_cat/templates/<template_name>`

`GET /_cat/templates`

[[cat-templates-api-prereqs]]
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.

[[cat-templates-path-params]]
==== {api-path-parms-title}

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

[[cat-templates-query-params]]
==== {api-query-parms-title}

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]

include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]


[[cat-templates-api-example]]
==== {api-examples-title}

[source,console]
----
GET _cat/templates/my-template-*?v=true&s=name
----
// TEST[s/^/PUT _index_template\/my-template-0\n{"index_patterns": "te*", "priority": 500}\n/]
// TEST[s/^/PUT _index_template\/my-template-1\n{"index_patterns": "tea*", "priority": 501}\n/]
// TEST[s/^/PUT _index_template\/my-template-2\n{"index_patterns": "teak*", "priority": 502, "version": 7}\n/]

The API returns the following response:

[source,txt]
----
name          index_patterns order version composed_of
my-template-0 [te*]          500           []
my-template-1 [tea*]         501           []
my-template-2 [teak*]        502   7       []
----
// TESTRESPONSE[s/\*/\\*/ s/\[/\\[/ s/\]/\\]/ non_json]

////
[source,console]
----
DELETE _index_template/my-template-0
DELETE _index_template/my-template-1
DELETE _index_template/my-template-2
----
// TEST[continued]
////