delete-index-template-v1.asciidoc 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. [[indices-delete-template-v1]]
  2. === Delete index template API
  3. ++++
  4. <titleabbrev>Delete index template (legacy)</titleabbrev>
  5. ++++
  6. IMPORTANT: This documentation is about <<indices-templates-v1,legacy index
  7. templates>>, which are deprecated and will be replaced by the composable
  8. templates introduced in {es} 7.8. For information about composable templates,
  9. see <<index-templates>>.
  10. Deletes a legacy index template.
  11. ////
  12. [source,console]
  13. --------------------------------------------------
  14. PUT _template/my-legacy-index-template
  15. {
  16. "index_patterns" : ["te*"],
  17. "settings": {
  18. "number_of_shards": 1
  19. }
  20. }
  21. --------------------------------------------------
  22. // TESTSETUP
  23. ////
  24. [source,console]
  25. --------------------------------------------------
  26. DELETE /_template/my-legacy-index-template
  27. --------------------------------------------------
  28. [[delete-template-api-v1-request]]
  29. ==== {api-request-title}
  30. `DELETE /_template/<legacy-index-template>`
  31. [[delete-template-api-v1-prereqs]]
  32. ==== {api-prereq-title}
  33. * If the {es} {security-features} are enabled, you must have the
  34. `manage_index_templates` or `manage` <<privileges-list-cluster,cluster
  35. privilege>> to use this API.
  36. [[delete-template-api-v1-path-params]]
  37. ==== {api-path-parms-title}
  38. `<legacy-index-template>`::
  39. (Required, string)
  40. The name of the legacy index template to delete. Wildcard (`*`)
  41. expressions are supported.
  42. [[delete-template-api-v1-query-params]]
  43. ==== {api-query-parms-title}
  44. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]