IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Freeze index API Get field mapping API »
Elastic Docs ›Elasticsearch Guide [7.8] ›REST APIs ›Index APIs

Get component template API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Get component template API

edit

Retrieves information about one or more component templates.

GET /_component_template/template_1

Request

edit

GET /_component-template/<component-template>

Path parameters

edit

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

Query parameters

edit
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) Specifies the period of time 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

edit

Get component templates using a wildcard expression

edit
GET /_component_template/temp*

Get all component templates

edit
GET /_component_template
« Freeze index API Get field mapping API »