IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« ES|QL async query get API Features APIs »

› › ›

ES|QL async query delete API

edit

ES|QL async query delete API

edit

The ES|QL 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=

Request

edit

DELETE /_query/async/<query_id>

Prerequisites

edit

If the Elasticsearch 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

Path parameters

edit

<query_id>

(Required, string) Identifier for the query to delete.

A query ID is provided in the ES|QL 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.

« ES|QL async query get API Features APIs »