delete-async-sql-search-api.asciidoc 1.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. [role="xpack"]
  2. [[delete-async-sql-search-api]]
  3. === Delete async SQL search API
  4. ++++
  5. <titleabbrev>Delete async SQL search</titleabbrev>
  6. ++++
  7. Deletes an <<sql-async,async SQL search>> or a <<sql-store-searches,stored
  8. synchronous SQL search>>. If the search is still running, the API cancels it.
  9. [source,console]
  10. ----
  11. DELETE _sql/async/delete/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
  12. ----
  13. // TEST[skip: no access to search ID]
  14. [[delete-async-sql-search-api-request]]
  15. ==== {api-request-title}
  16. `DELETE _sql/async/delete/<search_id>`
  17. [[delete-async-sql-search-api-prereqs]]
  18. ==== {api-prereq-title}
  19. * If the {es} {security-features} are enabled, only the following users can
  20. use this API to delete a search:
  21. ** Users with the `cancel_task` <<privileges-list-cluster,cluster privilege>>
  22. ** The user who first submitted the search
  23. [[delete-async-sql-search-api-limitations]]
  24. ===== Limitations
  25. See <<sql-limitations>>.
  26. [[delete-async-sql-search-api-path-params]]
  27. ==== {api-path-parms-title}
  28. `<search_id>`::
  29. (Required, string) Identifier for the search.