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

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. [[esql-async-query-delete-api]]
  2. === {esql} async query delete API
  3. ++++
  4. <titleabbrev>{esql} async query delete API</titleabbrev>
  5. ++++
  6. The {esql} async query delete API is used to manually delete an async query
  7. by ID. If the query is still running, the query will be cancelled. Otherwise,
  8. the stored results are deleted.
  9. [source,console]
  10. ----
  11. DELETE /query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
  12. ----
  13. // TEST[skip: no access to query ID]
  14. [[esql-async-query-delete-api-request]]
  15. ==== {api-request-title}
  16. `DELETE /_query/async/<query_id>`
  17. [[esql-async-query-delete-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 query:
  21. ** The authenticated user that submitted the original query request
  22. ** Users with the `cancel_task` <<privileges-list-cluster,cluster privilege>>
  23. [[esql-async-query-delete-api-path-params]]
  24. ==== {api-path-parms-title}
  25. `<query_id>`::
  26. (Required, string)
  27. Identifier for the query to delete.
  28. +
  29. A query ID is provided in the <<esql-async-query-api,{esql} async query API>>'s
  30. response for a query that does not complete in the awaited time. A query ID is
  31. also provided if the request's <<esql-async-query-api-keep-on-completion,`keep_on_completion`>>
  32. parameter is `true`.