elasticsearch/docs/reference/indices/delete-index-template.asciidoc
Nick Tindall 3ecdd77e97
[DOCS] Align docs to implementation for timeout parameters (#108593)
* [DOCS] Fix documentation for timeout-related parameters

Closes #108224
2024-05-16 13:05:39 +10: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=master-timeout]