OpenSearch/docs/reference/cat/templates.asciidoc

[[cat-templates]]
== cat templates

The `templates` command provides information about existing templates.

[source,js]
--------------------------------------------------
GET /_cat/templates?v&s=name
--------------------------------------------------
// CONSOLE
// TEST[s/templates/templates\/template*/]
// TEST[s/^/PUT _template\/template0\n{"index_patterns": "te*", "order": 0}\n/]
// TEST[s/^/PUT _template\/template1\n{"index_patterns": "tea*", "order": 1}\n/]
// TEST[s/^/PUT _template\/template2\n{"index_patterns": "teak*", "order": 2, "version": 7}\n/]
// The substitutions do two things:
// 1. Filter the response to just templates matching the te* pattern
//    so that we only get the templates we expect regardless of which
//    templates exist. If xpack is installed there will be unexpected
//    templates.
// 2. Create some templates to expect in the response.

which looks like

[source,txt]
--------------------------------------------------
name      index_patterns order version
template0 [te*]          0
template1 [tea*]         1
template2 [teak*]        2     7
--------------------------------------------------
// TESTRESPONSE[s/\*/\\*/ s/\[/\\[/ s/\]/\\]/ non_json]

The output shows that there are three existing templates,
with template2 having a version value.

The endpoint also supports giving a template name or pattern in the url
to filter the results, for example `/_cat/templates/template*` or
`/_cat/templates/template0`.