delete-transform.asciidoc 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[delete-data-frame-transform]]
  4. === Delete {dataframe-transforms} API
  5. [subs="attributes"]
  6. ++++
  7. <titleabbrev>Delete {dataframe-transforms}</titleabbrev>
  8. ++++
  9. Deletes an existing {dataframe-transform}.
  10. beta[]
  11. [[delete-data-frame-transform-request]]
  12. ==== {api-request-title}
  13. `DELETE _data_frame/transforms/<data_frame_transform_id>`
  14. [[delete-data-frame-transform-prereqs]]
  15. ==== {api-prereq-title}
  16. * Before you can delete the {dataframe-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 {stack-ov}/security-privileges.html[Security privileges] and
  21. {stack-ov}/built-in-roles.html[Built-in roles].
  22. [[delete-data-frame-transform-path-parms]]
  23. ==== {api-path-parms-title}
  24. `<data_frame_transform_id>`::
  25. (Required, string) Identifier for the {dataframe-transform}.
  26. [[delete-data-frame-transform-query-parms]]
  27. ==== {api-query-parms-title}
  28. `force`::
  29. (Optional, boolean) When `true`, the {dataframe-transform} is deleted regardless of its
  30. current state. The default value is `false`, meaning that the {dataframe-transform} must be
  31. `stopped` before it can be deleted.
  32. [[delete-data-frame-transform-examples]]
  33. ==== {api-examples-title}
  34. [source,js]
  35. --------------------------------------------------
  36. DELETE _data_frame/transforms/ecommerce_transform
  37. --------------------------------------------------
  38. // CONSOLE
  39. // TEST[skip:setup kibana sample data]
  40. When the {dataframe-transform} is deleted, you receive the following results:
  41. [source,console-result]
  42. ----
  43. {
  44. "acknowledged" : true
  45. }
  46. ----