mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 17:34:17 -04:00
601176364e
These can be retrieved using the `monitor` cluster privilege. This just adds that note to the docs.
97 lines
2.5 KiB
Text
97 lines
2.5 KiB
Text
[[getting-component-templates]]
|
|
=== Get component template API
|
|
++++
|
|
<titleabbrev>Get component template</titleabbrev>
|
|
++++
|
|
|
|
Retrieves information about one or more component templates.
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT /_component_template/template_1
|
|
{
|
|
"template": {
|
|
"settings": {
|
|
"index.number_of_replicas": 0
|
|
},
|
|
"mappings": {
|
|
"properties": {
|
|
"@timestamp": {
|
|
"type": "date"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|
|
// TESTSETUP
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
DELETE /_component_template/template_*
|
|
--------------------------------------------------
|
|
// TEARDOWN
|
|
|
|
//////////////////////////
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_component_template/template_1
|
|
--------------------------------------------------
|
|
|
|
[[get-component-template-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_component_template/<component-template>`
|
|
|
|
[[get-component-template-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the
|
|
`manage_index_templates` or `manage` <<privileges-list-cluster,cluster
|
|
privilege>> to update templates, or the `monitor` cluster privilege to retrieve templates.
|
|
|
|
[[get-component-template-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<component-template>`::
|
|
(Optional, string)
|
|
Comma-separated list of component template names used to limit the request.
|
|
Wildcard (`*`) expressions are supported.
|
|
|
|
|
|
[[get-component-template-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
|
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
|
|
|
`include_defaults`::
|
|
(Optional, Boolean) Functionality in preview:[]. If `true`, return all default settings in the response.
|
|
Defaults to `false`.
|
|
|
|
[[get-component-template-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
|
|
[[get-component-template-api-wildcard-ex]]
|
|
===== Get component templates using a wildcard expression
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_component_template/temp*
|
|
--------------------------------------------------
|
|
|
|
|
|
[[get-component-template-api-all-ex]]
|
|
===== Get all component templates
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_component_template
|
|
--------------------------------------------------
|