1
0

esql-async-query-delete-api.asciidoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. [[esql-async-query-delete-api]]
  2. === {esql} async query delete API
  3. ++++
  4. <titleabbrev>{esql} async query delete API</titleabbrev>
  5. ++++
  6. .New API reference
  7. [sidebar]
  8. --
  9. For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs].
  10. --
  11. The <<esql,{esql}>> async query delete API is used to manually delete an async query
  12. by ID. If the query is still running, the query will be cancelled. Otherwise,
  13. the stored results are deleted.
  14. [source,console]
  15. ----
  16. DELETE /query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
  17. ----
  18. // TEST[skip: no access to query ID]
  19. [[esql-async-query-delete-api-request]]
  20. ==== {api-request-title}
  21. `DELETE /_query/async/<query_id>`
  22. [[esql-async-query-delete-api-prereqs]]
  23. ==== {api-prereq-title}
  24. * If the {es} {security-features} are enabled, only the following users can
  25. use this API to delete a query:
  26. ** The authenticated user that submitted the original query request
  27. ** Users with the `cancel_task` <<privileges-list-cluster,cluster privilege>>
  28. [[esql-async-query-delete-api-path-params]]
  29. ==== {api-path-parms-title}
  30. `<query_id>`::
  31. (Required, string)
  32. Identifier for the query to delete.
  33. +
  34. A query ID is provided in the <<esql-async-query-api,{esql} async query API>>'s
  35. response for a query that does not complete in the awaited time. A query ID is
  36. also provided if the request's <<esql-async-query-api-keep-on-completion,`keep_on_completion`>>
  37. parameter is `true`.