Get component templates | Elasticsearch API (v8)

Get component templates Added in 5.1.0

GET /_cat/component_templates/{name}

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

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.

Path parameters

name string Required

The name of the component template. Accepts wildcard expressions. If omitted, all component templates are returned.

Responses

200 application/json
Hide response attributes Show response attributes object
- name string Required
- version string Required
- alias_count string Required
- mapping_count string Required
- settings_count string Required
- metadata_count string Required
- included_in string Required

GET /_cat/component_templates/{name}

curl \
 -X GET http://api.example.com/_cat/component_templates/{name}

Response examples (200)

[
  {
    "name": "string",
    "version": "string",
    "alias_count": "string",
    "mapping_count": "string",
    "settings_count": "string",
    "metadata_count": "string",
    "included_in": "string"
  }
]