delete-transform.asciidoc 1.3 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. beta[]
  10. Deletes an existing {dataframe-transform}.
  11. ==== Request
  12. `DELETE _data_frame/transforms/<data_frame_transform_id>`
  13. ==== Description
  14. NOTE: Before you can delete the {dataframe-transform}, you must stop it.
  15. ==== Path Parameters
  16. `data_frame_transform_id` (required)::
  17. (string) Identifier for the {dataframe-transform}.
  18. ==== Authorization
  19. If the {es} {security-features} are enabled, you must have
  20. `manage_data_frame_transforms` cluster privileges to use this API. The built-in
  21. `data_frame_transforms_admin` role has these privileges. For more information,
  22. see {stack-ov}/security-privileges.html[Security privileges] and
  23. {stack-ov}/built-in-roles.html[Built-in roles].
  24. ==== Examples
  25. The following example deletes the `ecommerce_transform` {dataframe-transform}:
  26. [source,js]
  27. --------------------------------------------------
  28. DELETE _data_frame/transforms/ecommerce_transform
  29. --------------------------------------------------
  30. // CONSOLE
  31. // TEST[skip:setup kibana sample data]
  32. When the {dataframe-transform} is deleted, you receive the following results:
  33. [source,js]
  34. ----
  35. {
  36. "acknowledged" : true
  37. }
  38. ----
  39. // TESTRESPONSE