delete-transform.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[delete-transform]]
  4. === Delete {transform} API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Delete {transform}</titleabbrev>
  8. ++++
  9. Deletes an existing {transform}.
  10. beta[]
  11. [[delete-transform-request]]
  12. ==== {api-request-title}
  13. `DELETE _transform/<transform_id>`
  14. [[delete-transform-prereqs]]
  15. ==== {api-prereq-title}
  16. * Before you can delete the {transform}, you must stop it.
  17. * If the {es} {security-features} are enabled, you must have `manage_transform`
  18. cluster privileges to use this API. The built-in `transform_admin` role has
  19. these privileges. For more information, see <<security-privileges>> and
  20. <<built-in-roles>>.
  21. [[delete-transform-path-parms]]
  22. ==== {api-path-parms-title}
  23. `<transform_id>`::
  24. (Required, string)
  25. include::{docdir}/rest-api/common-parms.asciidoc[tag=transform-id]
  26. [[delete-transform-query-parms]]
  27. ==== {api-query-parms-title}
  28. `force`::
  29. (Optional, boolean) When `true`, the {transform} is deleted regardless of its
  30. current state. The default value is `false`, meaning that the {transform} must be
  31. `stopped` before it can be deleted.
  32. [[delete-transform-examples]]
  33. ==== {api-examples-title}
  34. [source,console]
  35. --------------------------------------------------
  36. DELETE _transform/ecommerce_transform
  37. --------------------------------------------------
  38. // TEST[skip:setup kibana sample data]
  39. When the {transform} is deleted, you receive the following results:
  40. [source,console-result]
  41. ----
  42. {
  43. "acknowledged" : true
  44. }
  45. ----