OpenSearch/docs/reference/indices/delete-index-template.asciidoc

55 lines
1.1 KiB
Plaintext

[[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>`
[[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 <<indices-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]