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

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