This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
Get component template API
editGet component template APIedit
Retrieves information about one or more component templates.
response = client.cluster.get_component_template( name: 'template_1' ) puts response
GET /_component_template/template_1
Requestedit
GET /_component_template/<component-template>
Prerequisitesedit
-
If the Elasticsearch security features are enabled, you must have the
manage_index_templates
ormanage
cluster privilege to update templates, or themonitor
cluster privilege to retrieve templates.
Path parametersedit
-
<component-template>
-
(Optional, string)
Comma-separated list of component template names used to limit the request.
Wildcard (
*
) expressions are supported.
Query parametersedit
-
flat_settings
-
(Optional, Boolean) If
true
, returns settings in flat format. Defaults tofalse
. -
local
-
(Optional, Boolean) If
true
, the request retrieves information from the local node only. Defaults tofalse
, which means information is retrieved from the master node. -
master_timeout
-
(Optional, time units)
Period to wait for the master node. If the master node is not available before
the timeout expires, the request fails and returns an error. Defaults to
30s
. Can also be set to-1
to indicate that the request should never timeout. -
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 tofalse
.