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

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[delete-async-eql-search-api]]
  4. === Delete async EQL search API
  5. ++++
  6. <titleabbrev>Delete async EQL search</titleabbrev>
  7. ++++
  8. dev::[]
  9. Deletes an <<eql-search-async,async EQL search>> or a
  10. <<eql-search-store-sync-eql-search,stored synchronous EQL search>>. The API also
  11. deletes results for the search.
  12. [source,console]
  13. ----
  14. DELETE /_eql/search/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
  15. ----
  16. // TEST[skip: no access to search ID]
  17. [[delete-async-eql-search-api-request]]
  18. ==== {api-request-title}
  19. `DELETE /_eql/search/<search_id>`
  20. [[delete-async-eql-search-api-prereqs]]
  21. ==== {api-prereq-title}
  22. See <<eql-requirements,EQL requirements>>.
  23. [[delete-async-eql-search-api-limitations]]
  24. ===== Limitations
  25. See <<eql-limitations,EQL limitations>>.
  26. [[delete-async-eql-search-api-path-params]]
  27. ==== {api-path-parms-title}
  28. `<search_id>`::
  29. (Required, string)
  30. Identifier for the search to delete.
  31. +
  32. A search ID is provided in the <<eql-search-api,EQL search API>>'s response for
  33. an <<eql-search-async,async search>>. A search ID is also provided if the
  34. request's <<eql-search-api-keep-on-completion,`keep_on_completion`>> parameter
  35. is `true`.