delete-component-template.asciidoc 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. [[indices-delete-component-template]]
  2. === Delete component template API
  3. ++++
  4. <titleabbrev>Delete component template</titleabbrev>
  5. ++++
  6. Deletes an existing component template.
  7. ////
  8. [source,console]
  9. --------------------------------------------------
  10. PUT _component_template/template_1
  11. {
  12. "template": {
  13. "settings": {
  14. "index.number_of_replicas": 0
  15. }
  16. }
  17. }
  18. --------------------------------------------------
  19. // TESTSETUP
  20. ////
  21. [source,console]
  22. --------------------------------------------------
  23. DELETE _component_template/template_1
  24. --------------------------------------------------
  25. The provided <component-template> may contain multiple template names separated by a comma.
  26. If multiple template names are specified then there is no wildcard support and the
  27. provided names should match completely with existing component templates.
  28. [[delete-component-template-api-request]]
  29. ==== {api-request-title}
  30. `DELETE /_component_template/<component-template>`
  31. [[delete-component-template-api-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-component-template-api-desc]]
  37. ==== {api-description-title}
  38. Use the delete component template API to delete one or more component templates
  39. Component templates are building blocks for constructing <<index-templates,index templates>>
  40. that specify index mappings, settings, and aliases.
  41. [[delete-component-template-api-path-params]]
  42. ==== {api-path-parms-title}
  43. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=component-template]
  44. [[delete-component-template-api-query-params]]
  45. ==== {api-query-parms-title}
  46. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]