Get component templates

GET /_cat/component_templates/{name}
GET /_cat/component_templates

Get information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.

Required authorization

Cluster privileges: monitor

Path Parameters

name string optional

The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned.

Leave it out to use /_cat/component_templates.

Query Parameters

Response

application/json

Examples

A successful response from GET _cat/component_templates/my-template-*?v=true&s=name&format=json.

Request Console 1 / 7 languages

Console Kibana Dev Tools

GET _cat/component_templates/my-template-*?v=true&s=name&format=json

JavaScript Elasticsearch JavaScript Client

const response = await client.cat.componentTemplates({
  name: "my-template-*",
  v: "true",
  s: "name",
  format: "json",
});

Python Elasticsearch Python Client

resp = client.cat.component_templates(
    name="my-template-*",
    v=True,
    s="name",
    format="json",
)

curl Shell

curl -X GET "$ELASTICSEARCH_URL/_cat/component_templates/my-template-*?v=true&s=name&format=json" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.cat().componentTemplates(c -> c
    .name("my-template-*")
    .s("name")
);

PHP Elasticsearch PHP Client

$resp = $client->cat()->componentTemplates([
    "name" => "my-template-*",
    "v" => "true",
    "s" => "name",
    "format" => "json",
]);

Ruby Elasticsearch Ruby Client

response = client.cat.component_templates(
  name: "my-template-*",
  v: "true",
  s: "name",
  format: "json"
)

Response

[
  {
    "name": "my-template-1",
    "version": "null",
    "alias_count": "0",
    "mapping_count": "0",
    "settings_count": "1",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  },
    {
    "name": "my-template-2",
    "version": null,
    "alias_count": "0",
    "mapping_count": "3",
    "settings_count": "0",
    "metadata_count": "0",
    "included_in": "[my-index-template]"
  }
]

Required authorization

Path Parameters

Query Parameters { h , s , local , master_timeout , }

Response

Query Parameters