elasticsearch/docs/reference/indices/delete-index-template.asciidoc
Liam Thompson 33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* 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
2024-04-17 14:37:07 +02:00

64 lines
1.5 KiB
Text

[[indices-delete-template]]
=== Delete index template API
++++
<titleabbrev>Delete index template</titleabbrev>
++++
Deletes an <<index-templates,index template>>.
////
[source,console]
----
PUT /_index_template/my-index-template
{
"index_patterns" : ["te*"],
"template": {
"settings": {
"number_of_shards": 1
}
}
}
----
// TESTSETUP
////
[source,console]
----
DELETE /_index_template/my-index-template
----
[[delete-template-api-request]]
==== {api-request-title}
`DELETE /_index_template/<index-template>`
The provided <index-template> may contain multiple template names separated by a comma.
If multiple template names are specified then there is no wildcard support and the
provided names should match completely with existing templates.
[[delete-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 use this API.
[[delete-template-api-desc]]
==== {api-description-title}
Use the delete index template API to delete one or more index templates.
Index templates define <<index-modules-settings,settings>>, <<mapping,mappings>>,
and <<aliases,aliases>> that can be applied automatically to new indices.
[[delete-template-api-path-params]]
==== {api-path-parms-title}
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=index-template]
[[delete-template-api-query-params]]
==== {api-query-parms-title}
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]