Skip to content

Latest commit

 

History

History
48 lines (37 loc) · 1.42 KB

esql-async-query-delete-api.asciidoc

File metadata and controls

48 lines (37 loc) · 1.42 KB

{esql} async query delete API

{esql} async query delete API
New API reference

For the most up-to-date API details, refer to {api-es}/group/endpoint-esql[ES|QL APIs].

The {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.

DELETE /query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

{api-request-title}

DELETE /_query/async/<query_id>

{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 cluster privilege

{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's response for a query that does not complete in the awaited time. A query ID is also provided if the request’s keep_on_completion parameter is true.