delete-async-eql-search-api.asciidoc 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. [role="xpack"]
  2. [[delete-async-eql-search-api]]
  3. === Delete async EQL search API
  4. ++++
  5. <titleabbrev>Delete async EQL search</titleabbrev>
  6. ++++
  7. Deletes an <<eql-search-async,async EQL search>> or a
  8. <<eql-search-store-sync-eql-search,stored synchronous EQL search>>. The API also
  9. deletes results for the search.
  10. [source,console]
  11. ----
  12. DELETE /_eql/search/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
  13. ----
  14. // TEST[skip: no access to search ID]
  15. [[delete-async-eql-search-api-request]]
  16. ==== {api-request-title}
  17. `DELETE /_eql/search/<search_id>`
  18. [[delete-async-eql-search-api-prereqs]]
  19. ==== {api-prereq-title}
  20. * If the {es} {security-features} are enabled, only the following users can
  21. use this API to delete a search:
  22. ** Users with the `cancel_task` <<privileges-list-cluster,cluster privilege>>
  23. ** The user who first submitted the search
  24. * See <<eql-required-fields>>.
  25. [[delete-async-eql-search-api-limitations]]
  26. ===== Limitations
  27. See <<eql-syntax-limitations,EQL limitations>>.
  28. [[delete-async-eql-search-api-path-params]]
  29. ==== {api-path-parms-title}
  30. `<search_id>`::
  31. (Required, string)
  32. Identifier for the search to delete.
  33. +
  34. A search ID is provided in the <<eql-search-api,EQL search API>>'s response for
  35. an <<eql-search-async,async search>>. A search ID is also provided if the
  36. request's <<eql-search-api-keep-on-completion,`keep_on_completion`>> parameter
  37. is `true`.