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 API
editRetrieves information about one or more component templates.
resp = client.cluster.get_component_template( name="template_1", ) print(resp)
response = client.cluster.get_component_template( name: 'template_1' ) puts response
const response = await client.cluster.getComponentTemplate({ name: "template_1", }); console.log(response);
GET /_component_template/template_1
Request
editGET /_component_template/<component-template>
Prerequisites
edit-
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 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 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
.
Examples
editGet component templates using a wildcard expression
editresp = client.cluster.get_component_template( name="temp*", ) print(resp)
response = client.cluster.get_component_template( name: 'temp*' ) puts response
const response = await client.cluster.getComponentTemplate({ name: "temp*", }); console.log(response);
GET /_component_template/temp*
Get all component templates
editresp = client.cluster.get_component_template() print(resp)
response = client.cluster.get_component_template puts response
const response = await client.cluster.getComponentTemplate(); console.log(response);
GET /_component_template