› › ›

Get component template API

Retrieves information about one or more component templates.

GET /_component_template/template_1

Request

GET /_component_template/<component-template>

Prerequisites

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

Path parameters

<component-template>: (Optional, string) Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported.

Query parameters

flat_settings: (Optional, Boolean) If true, returns settings in flat format. 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.

Examples

Get component templates using a wildcard expression

GET /_component_template/temp*

Get all component templates

GET /_component_template

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/getting-component-templates.html