delete-transform.asciidoc 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  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-examples]]
  27. ==== {api-examples-title}
  28. [source,js]
  29. --------------------------------------------------
  30. DELETE _data_frame/transforms/ecommerce_transform
  31. --------------------------------------------------
  32. // CONSOLE
  33. // TEST[skip:setup kibana sample data]
  34. When the {dataframe-transform} is deleted, you receive the following results:
  35. [source,js]
  36. ----
  37. {
  38. "acknowledged" : true
  39. }
  40. ----
  41. // TESTRESPONSE