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

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. [role="xpack"]
  2. [testenv="basic"]
  3. [[delete-async-sql-search-api]]
  4. === Delete async SQL search API
  5. ++++
  6. <titleabbrev>Delete async SQL search</titleabbrev>
  7. ++++
  8. Deletes an <<sql-async,async SQL search>> or a <<sql-store-searches,stored
  9. synchronous SQL search>>. If the search is still running, the API cancels it.
  10. [source,console]
  11. ----
  12. DELETE /_sql/async/delete/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
  13. ----
  14. // TEST[skip: no access to search ID]
  15. [[delete-async-sql-search-api-request]]
  16. ==== {api-request-title}
  17. `DELETE /_sql/async/delete/<search_id>`
  18. [[delete-async-sql-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. [[delete-async-sql-search-api-limitations]]
  25. ===== Limitations
  26. See <<sql-limitations>>.
  27. [[delete-async-sql-search-api-path-params]]
  28. ==== {api-path-parms-title}
  29. `<search_id>`::
  30. (Required, string) Identifier for the search.