|
@@ -85,14 +85,14 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
|
|
[[put-index-template-api-request-body]]
|
|
|
==== {api-request-body-title}
|
|
|
|
|
|
-`index_patterns`::
|
|
|
-(Required, array of strings)
|
|
|
-Array of wildcard (`*`) expressions
|
|
|
-used to match the names of data streams and indices during creation.
|
|
|
-+
|
|
|
-include::{es-repo-dir}/indices/index-templates.asciidoc[tag=built-in-index-templates]
|
|
|
+`composed_of`::
|
|
|
+(Optional, array of strings)
|
|
|
+An ordered list of component template names. Component templates are merged in the order
|
|
|
+specified, meaning that the last component template specified has the highest precedence. See
|
|
|
+<<multiple-component-templates,Composing multiple component templates>> for an example.
|
|
|
|
|
|
-[xpack]#`data_stream`#::
|
|
|
+// tag::index-template-api-body[]
|
|
|
+`data_stream`::
|
|
|
(Optional, object)
|
|
|
If this object is included, the template is used to create data streams and
|
|
|
their backing indices. Supports an empty object: `data_stream: { }`
|
|
@@ -103,12 +103,31 @@ See <<create-index-template,create an index template>>.
|
|
|
.Properties of `data_stream`
|
|
|
[%collapsible%open]
|
|
|
====
|
|
|
-[[data-stream-hidden]]
|
|
|
`hidden`::
|
|
|
(Optional, Boolean)
|
|
|
If `true`, the data stream is <<hidden-indices,hidden>>. Defaults to `false`.
|
|
|
====
|
|
|
|
|
|
+`index_patterns`::
|
|
|
+(Required, array of strings)
|
|
|
+Array of wildcard (`*`) expressions
|
|
|
+used to match the names of data streams and indices during creation.
|
|
|
++
|
|
|
+{es} includes several built-in index templates. To avoid naming collisions with
|
|
|
+these templates, see <<avoid-index-pattern-collisions>>.
|
|
|
+
|
|
|
+`_meta`::
|
|
|
+(Optional, object)
|
|
|
+Optional user metadata about the index template. May have any contents.
|
|
|
+This map is not automatically generated by {es}.
|
|
|
+
|
|
|
+`priority`::
|
|
|
+(Optional, integer)
|
|
|
+Priority to determine index template precedence when a new data stream or index is created. The index template with
|
|
|
+the highest priority is chosen. If no priority is specified the template is treated as though it is
|
|
|
+of priority 0 (lowest priority).
|
|
|
+This number is not automatically generated by {es}.
|
|
|
+
|
|
|
`template`::
|
|
|
(Optional, object)
|
|
|
Template to be applied. It may optionally include an `aliases`, `mappings`, or
|
|
@@ -126,28 +145,11 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=mappings]
|
|
|
include::{docdir}/rest-api/common-parms.asciidoc[tag=settings]
|
|
|
====
|
|
|
|
|
|
-`composed_of`::
|
|
|
-(Optional, array of strings)
|
|
|
-An ordered list of component template names. Component templates are merged in the order
|
|
|
-specified, meaning that the last component template specified has the highest precedence. See
|
|
|
-<<multiple-component-templates,Composing multiple component templates>> for an example.
|
|
|
-
|
|
|
-`priority`::
|
|
|
-(Optional, integer)
|
|
|
-Priority to determine index template precedence when a new data stream or index is created. The index template with
|
|
|
-the highest priority is chosen. If no priority is specified the template is treated as though it is
|
|
|
-of priority 0 (lowest priority).
|
|
|
-This number is not automatically generated by {es}.
|
|
|
-
|
|
|
`version`::
|
|
|
(Optional, integer)
|
|
|
Version number used to manage index templates externally.
|
|
|
This number is not automatically generated by {es}.
|
|
|
-
|
|
|
-`_meta`::
|
|
|
-(Optional, object)
|
|
|
-Optional user metadata about the index template. May have any contents.
|
|
|
-This map is not automatically generated by {es}.
|
|
|
+// end::index-template-api-body[]
|
|
|
|
|
|
[[put-index-template-api-example]]
|
|
|
==== {api-examples-title}
|