elasticsearch/docs/reference/indices/delete-component-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

61 lines
1.8 KiB
Text

[[indices-delete-component-template]]
=== Delete component template API
++++
<titleabbrev>Delete component template</titleabbrev>
++++
Deletes an existing component template.
////
[source,console]
--------------------------------------------------
PUT _component_template/template_1
{
"template": {
"settings": {
"index.number_of_replicas": 0
}
}
}
--------------------------------------------------
// TESTSETUP
////
[source,console]
--------------------------------------------------
DELETE _component_template/template_1
--------------------------------------------------
The provided <component-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 component templates.
[[delete-component-template-api-request]]
==== {api-request-title}
`DELETE /_component_template/<component-template>`
[[delete-component-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-component-template-api-desc]]
==== {api-description-title}
Use the delete component template API to delete one or more component templates
Component templates are building blocks for constructing <<index-templates,index templates>>
that specify index mappings, settings, and aliases.
[[delete-component-template-api-path-params]]
==== {api-path-parms-title}
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=component-template]
[[delete-component-template-api-query-params]]
==== {api-query-parms-title}
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]