delete-transform.asciidoc 1.5 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. beta[]
  10. Deletes an existing {dataframe-transform}.
  11. [discrete]
  12. [[delete-data-frame-transform-request]]
  13. ==== {api-request-title}
  14. `DELETE _data_frame/transforms/<data_frame_transform_id>`
  15. [discrete]
  16. [[delete-data-frame-transform-prereqs]]
  17. ==== {api-prereq-title}
  18. If the {es} {security-features} are enabled, you must have
  19. `manage_data_frame_transforms` cluster privileges to use this API. The built-in
  20. `data_frame_transforms_admin` role has these privileges. For more information,
  21. see {stack-ov}/security-privileges.html[Security privileges] and
  22. {stack-ov}/built-in-roles.html[Built-in roles].
  23. [discrete]
  24. [[delete-data-frame-transform-desc]]
  25. ==== {api-description-title}
  26. NOTE: Before you can delete the {dataframe-transform}, you must stop it.
  27. [discrete]
  28. [[delete-data-frame-transform-path-parms]]
  29. ==== {api-path-parms-title}
  30. `<data_frame_transform_id>` (Required)::
  31. (string) Identifier for the {dataframe-transform}.
  32. [discrete]
  33. [[delete-data-frame-transform-examples]]
  34. ==== {api-example-title}
  35. [source,js]
  36. --------------------------------------------------
  37. DELETE _data_frame/transforms/ecommerce_transform
  38. --------------------------------------------------
  39. // CONSOLE
  40. // TEST[skip:setup kibana sample data]
  41. When the {dataframe-transform} is deleted, you receive the following results:
  42. [source,js]
  43. ----
  44. {
  45. "acknowledged" : true
  46. }
  47. ----
  48. // TESTRESPONSE