delete_component_template.asciidoc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. --
  2. :api: delete-component-template
  3. :request: DeleteComponentTemplateRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Delete Component Template API
  8. [id="{upid}-{api}-request"]
  9. ==== Request
  10. The Delete Component Template API allows you to delete a component template.
  11. ["source","java",subs="attributes,callouts,macros"]
  12. --------------------------------------------------
  13. include-tagged::{doc-tests-file}[{api}-request]
  14. --------------------------------------------------
  15. <1> The name of the component template to delete.
  16. === Optional arguments
  17. The following arguments can optionally be provided:
  18. ["source","java",subs="attributes,callouts,macros"]
  19. --------------------------------------------------
  20. include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
  21. --------------------------------------------------
  22. <1> Timeout to connect to the master node as a `TimeValue`
  23. [id="{upid}-{api}-response"]
  24. ==== Response
  25. The returned +{response}+ indicates if the delete component template request was received.
  26. ["source","java",subs="attributes,callouts,macros"]
  27. --------------------------------------------------
  28. include-tagged::{doc-tests-file}[{api}-response]
  29. --------------------------------------------------
  30. <1> Whether or not the delete component template request was acknowledged.
  31. include::../execution.asciidoc[]