elasticsearch/docs/reference/indices/delete-index-template.asciidoc
James Rodewig cfae69717a
[DOCS] Update anchor and add redirect for aliases (#77349)
PRs #73062 and #73043 repurposed the `alias` anchor for a new guide for index
and data stream aliases. Previously, this anchor was used for our field alias
documentation.

Repurposing the anchor has caused continuity errors for users selecting
different versions of the ES docs. It could also cause confusion for users with
a `/current/` link to the `alias` page.

This updates the anchor for the alias guide and adds a redirect page to
disambiguate the `alias` anchor.

It also fixes a bread crumb issue for redirects following the 'Modifying your
Data' redirect page.

Closes #77034.
2021-09-07 09:42:42 -04: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-repo-dir}/rest-api/common-parms.asciidoc[tag=index-template]
[[delete-template-api-query-params]]
==== {api-query-parms-title}
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]