delete-transform.asciidoc 1.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  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. * Requires the `manage_transform` cluster privilege. This privilege is included
  16. in the `transform_admin` built-in role.
  17. * Before you can delete the {transform}, you must stop it.
  18. [[delete-transform-path-parms]]
  19. == {api-path-parms-title}
  20. `<transform_id>`::
  21. (Required, string)
  22. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
  23. [[delete-transform-query-parms]]
  24. == {api-query-parms-title}
  25. `force`::
  26. (Optional, Boolean) When `true`, the {transform} is deleted regardless of its
  27. current state. The default value is `false`, meaning that the {transform} must be
  28. `stopped` before it can be deleted.
  29. [[delete-transform-examples]]
  30. == {api-examples-title}
  31. [source,console]
  32. --------------------------------------------------
  33. DELETE _transform/ecommerce_transform
  34. --------------------------------------------------
  35. // TEST[skip:setup kibana sample data]
  36. When the {transform} is deleted, you receive the following results:
  37. [source,console-result]
  38. ----
  39. {
  40. "acknowledged" : true
  41. }
  42. ----