elasticsearch/docs/reference/indices/delete-index-template-v1.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

58 lines
1.5 KiB
Text

[[indices-delete-template-v1]]
=== Delete index template API
++++
<titleabbrev>Delete index template (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>>.
Deletes a legacy index template.
////
[source,console]
--------------------------------------------------
PUT _template/my-legacy-index-template
{
"index_patterns" : ["te*"],
"settings": {
"number_of_shards": 1
}
}
--------------------------------------------------
// TESTSETUP
////
[source,console]
--------------------------------------------------
DELETE /_template/my-legacy-index-template
--------------------------------------------------
[[delete-template-api-v1-request]]
==== {api-request-title}
`DELETE /_template/<legacy-index-template>`
[[delete-template-api-v1-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-v1-path-params]]
==== {api-path-parms-title}
`<legacy-index-template>`::
(Required, string)
The name of the legacy index template to delete. Wildcard (`*`)
expressions are supported.
[[delete-template-api-v1-query-params]]
==== {api-query-parms-title}
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]