delete-datafeed.asciidoc 1.1 KB

12345678910111213141516171819202122232425262728293031323334
  1. --
  2. :api: delete-datafeed
  3. :request: DeleteDatafeedRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-delete-datafeed"]
  8. === Delete datafeed API
  9. Deletes an existing datafeed.
  10. [id="{upid}-{api}-request"]
  11. ==== Delete datafeed request
  12. A +{request}+ object requires a non-null `datafeedId` and can optionally set `force`.
  13. ["source","java",subs="attributes,callouts,macros"]
  14. ---------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. ---------------------------------------------------
  17. <1> Use to forcefully delete a started datafeed. This method is quicker than
  18. stopping and deleting the datafeed. Defaults to `false`.
  19. include::../execution.asciidoc[]
  20. [id="{upid}-{api}-response"]
  21. ==== Delete datafeed response
  22. The returned +{response}+ object indicates the acknowledgement of the request:
  23. ["source","java",subs="attributes,callouts,macros"]
  24. ---------------------------------------------------
  25. include-tagged::{doc-tests-file}[{api}-response]
  26. ---------------------------------------------------
  27. <1> `isAcknowledged` was the deletion request acknowledged or not.