mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 09:28:55 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
66 lines
1.8 KiB
Text
66 lines
1.8 KiB
Text
[[indices-template-exists-v1]]
|
|
=== Index template exists API
|
|
++++
|
|
<titleabbrev>Index template exists (legacy)</titleabbrev>
|
|
++++
|
|
|
|
IMPORTANT: This documentation is about <<indices-templates-v1,legacy index
|
|
templates>>, which are deprecated and will be replaced by the composable
|
|
templates introduced in {es} 7.8. For information about composable templates,
|
|
see <<index-templates>>.
|
|
|
|
Checks if an <<indices-templates-v1,legacy index template>> exists.
|
|
|
|
|
|
|
|
[source,console]
|
|
-----------------------------------------------
|
|
HEAD /_template/template_1
|
|
-----------------------------------------------
|
|
|
|
|
|
[[template-exists-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`HEAD /_template/<index-template>`
|
|
|
|
[[template-exists-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 use this API.
|
|
|
|
[[template-exists-api-desc]]
|
|
==== {api-description-title}
|
|
|
|
Use the index template exists API
|
|
to determine whether one or more index templates exist.
|
|
|
|
Index templates define <<index-modules-settings,settings>>, <<mapping,mappings>>,
|
|
and <<aliases,aliases>> that can be applied automatically to new indices.
|
|
|
|
[[template-exists-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-template]
|
|
|
|
|
|
[[template-exists-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=flat-settings]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
|
|
|
|
|
[[template-exists-api-response-codes]]
|
|
==== {api-response-codes-title}
|
|
|
|
`200`::
|
|
Indicates all specified index templates exist.
|
|
|
|
`404`::
|
|
Indicates one or more specified index templates **do not** exist.
|