New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get alias API Get field mapping API »
Elastic Docs ›Elasticsearch Guide [8.11] ›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.

response = client.cluster.get_component_template(
  name: 'template_1'
)
puts response
GET /_component_template/template_1
Copy as curlTry in Elastic 

Request

edit

GET /_component_template/<component-template>

Prerequisites

edit
  • If the Elasticsearch security features are enabled, you must have the manage_index_templates or manage cluster privilege to update templates, or the monitor cluster privilege to retrieve templates.

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) 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.
include_defaults
(Optional, Boolean) Functionality in [preview] This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features. . If true, return all default settings in the response. Defaults to false.

Examples

edit

Get component templates using a wildcard expression

edit
response = client.cluster.get_component_template(
  name: 'temp*'
)
puts response
GET /_component_template/temp*
Copy as curlTry in Elastic 

Get all component templates

edit
response = client.cluster.get_component_template
puts response
GET /_component_template
Copy as curlTry in Elastic 
« Get alias API Get field mapping API »
Was this helpful?
Feedback