123456789101112131415161718192021222324252627282930313233343536373839404142434445464748 |
- [[esql-async-query-delete-api]]
- === {esql} async query delete API
- ++++
- <titleabbrev>{esql} async query delete API</titleabbrev>
- ++++
- .New API reference
- [sidebar]
- --
- For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs].
- --
- The <<esql,{esql}>> async query delete API is used to manually delete an async query
- by ID. If the query is still running, the query will be cancelled. Otherwise,
- the stored results are deleted.
- [source,console]
- ----
- DELETE /query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
- ----
- // TEST[skip: no access to query ID]
- [[esql-async-query-delete-api-request]]
- ==== {api-request-title}
- `DELETE /_query/async/<query_id>`
- [[esql-async-query-delete-api-prereqs]]
- ==== {api-prereq-title}
- * If the {es} {security-features} are enabled, only the following users can
- use this API to delete a query:
- ** The authenticated user that submitted the original query request
- ** Users with the `cancel_task` <<privileges-list-cluster,cluster privilege>>
- [[esql-async-query-delete-api-path-params]]
- ==== {api-path-parms-title}
- `<query_id>`::
- (Required, string)
- Identifier for the query to delete.
- +
- A query ID is provided in the <<esql-async-query-api,{esql} async query API>>'s
- response for a query that does not complete in the awaited time. A query ID is
- also provided if the request's <<esql-async-query-api-keep-on-completion,`keep_on_completion`>>
- parameter is `true`.
|