delete-transform.asciidoc 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. [role="xpack"]
  2. [[delete-transform]]
  3. = Delete {transform} API
  4. [subs="attributes"]
  5. ++++
  6. <titleabbrev>Delete {transform}</titleabbrev>
  7. ++++
  8. Deletes an existing {transform}.
  9. [[delete-transform-request]]
  10. == {api-request-title}
  11. `DELETE _transform/<transform_id>`
  12. [[delete-transform-prereqs]]
  13. == {api-prereq-title}
  14. * Requires the `manage_transform` cluster privilege. This privilege is included
  15. in the `transform_admin` built-in role.
  16. * Before you can delete the {transform}, you must stop it.
  17. [[delete-transform-path-parms]]
  18. == {api-path-parms-title}
  19. `<transform_id>`::
  20. (Required, string)
  21. include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=transform-id]
  22. [[delete-transform-query-parms]]
  23. == {api-query-parms-title}
  24. `force`::
  25. (Optional, Boolean) When `true`, the {transform} is deleted regardless of its
  26. current state. The default value is `false`, meaning that the {transform} must be
  27. `stopped` before it can be deleted.
  28. `delete_dest_index`::
  29. (Optional, Boolean) When `true`, the destination index is deleted together with
  30. the {transform}. The default value is `false`, meaning that the destination
  31. index will not be deleted.
  32. `timeout`::
  33. (Optional, time)
  34. Period to wait for a response. If no response is received before the timeout
  35. expires, the request fails and returns an error. Defaults to `30s`.
  36. [[delete-transform-examples]]
  37. == {api-examples-title}
  38. [source,console]
  39. --------------------------------------------------
  40. DELETE _transform/ecommerce_transform
  41. --------------------------------------------------
  42. // TEST[skip:setup kibana sample data]
  43. When the {transform} is deleted, you receive the following results:
  44. [source,console-result]
  45. ----
  46. {
  47. "acknowledged" : true
  48. }
  49. ----