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

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  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. See <<eql-required-fields>>.
  22. [[delete-async-eql-search-api-limitations]]
  23. ===== Limitations
  24. See <<eql-syntax-limitations,EQL limitations>>.
  25. [[delete-async-eql-search-api-path-params]]
  26. ==== {api-path-parms-title}
  27. `<search_id>`::
  28. (Required, string)
  29. Identifier for the search to delete.
  30. +
  31. A search ID is provided in the <<eql-search-api,EQL search API>>'s response for
  32. an <<eql-search-async,async search>>. A search ID is also provided if the
  33. request's <<eql-search-api-keep-on-completion,`keep_on_completion`>> parameter
  34. is `true`.