delete-transform.asciidoc 1.4 KB

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