Create or update a component template
- POST also PUT /_component_template/{name}
Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
An index template can be composed of multiple component templates.
To use a component template, specify it in an index template’s composed_of list.
Component templates are only applied to new data streams and indices as part of a matching index template.
Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.
Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s backing indices.
You can use C-style /* *\/ block comments in component templates.
You can include comments anywhere in the request body except before the opening curly bracket.
Applying component templates
You cannot directly apply a component template to a data stream or index.
To be applied, a component template must be included in an index template's composed_of list.
Required authorization
- Cluster privileges manage_index_templates
Path parameters
-
namestringrequired -
Name of the component template to create. Elasticsearch includes the following built-in component templates:
logs-mappings;logs-settings;metrics-mappings;metrics-settings;synthetics-mapping;synthetics-settings. Elastic Agent uses these templates to configure backing indices for its data streams. If you use Elastic Agent and want to overwrite one of these templates, set theversionfor your replacement template higher than the current version. If you don’t use Elastic Agent and want to disable all built-in component and index templates, setstack.templates.enabledtofalseusing the cluster update settings API.
Request body
-
templateobjectrequired -
The template to be applied which includes mappings, settings, or aliases configuration.
-
aliasesmap string to object -
Aliases to add. If the index template includes a
data_streamobject, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore theindex_routing,routing, andsearch_routingoptions. -
<string>object -
filterQuery -
Query used to limit documents the alias can access.
-
index_routingstring -
Value used to route indexing operations to a specific shard. If specified, this overwrites the
routingvalue for indexing operations. -
If
true, the alias is hidden. All indices for the alias must have the sameis_hiddenvalue. -
mappingsobject -
Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters.
-
lifecycleobject -
data_retentionstring -
If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely.
-
retention_determined_by -
Configuration source that can influence the retention of a data stream.
-
Values:
data_stream_configurationdefault_global_retentionmax_global_retentiondefault_failures_retention -
downsamplingobject -
The list of downsampling rounds to execute as part of this downsampling configuration
-
versionnumber -
Version number used to manage component templates externally. This number isn't automatically generated or incremented by Elasticsearch. To unset a version, replace the template without specifying a version.
-
_metaobject -
Optional user metadata about the component template. It may have any contents. This map is not automatically generated by Elasticsearch. This information is stored in the cluster state, so keeping it short is preferable. To unset
_meta, replace the template without specifying this information.