Files
elasticsearch-js/docs/reference/api/ClusterPutComponentTemplateRequest.md
2025-05-28 10:02:30 -05:00

2.5 KiB
Raw Permalink Blame History

ClusterPutComponentTemplateRequest [interface-ClusterPutComponentTemplateRequest]

Name Type Description
_meta Metadata 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.
body string ({ [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; template?: never; version?: never; _meta?: never; deprecated?: never; })
create boolean If true, this request cannot replace or update existing component templates.
deprecated boolean Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.
master_timeout Duration 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.
name Name 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 the version for 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, set stack.templates.enabled to false using the cluster update settings API.
querystring { [key: string]: any; } & { name?: never; create?: never; master_timeout?: never; template?: never; version?: never; _meta?: never; deprecated?: never; } All values in querystring will be added to the request querystring.
template IndicesIndexState The template to be applied which includes mappings, settings, or aliases configuration.
version 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.