1
0

delete-transform.asciidoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[delete-transform]]
  4. === Delete {transforms} API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Delete {transforms}</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
  18. `manage_data_frame_transforms` cluster privileges to use this API. The built-in
  19. `data_frame_transforms_admin` role has these privileges. For more information,
  20. see <<security-privileges>> and <<built-in-roles>>.
  21. [[delete-transform-path-parms]]
  22. ==== {api-path-parms-title}
  23. `<transform_id>`::
  24. (Required, string) Identifier for the {transform}.
  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. ----