New

The executive guide to generative AI

Read more

ES|QL async query stop API

edit

The ES|QL async query stop API is used to manually stop an async query. Once the stop command is issued, the query stops processing new data and returns the results that have been already processed. Note that due to the pipelined nature of ES|QL queries, the stop operation is not immediate and may take time to return results.

The results are returned in the same format as the ES|QL async query get API. If the query has been finished by the time the stop command is issued, the results are returned immediately.

If the query processing has not finished by the time the stop command is issued, the response will have the is_partial field set to true.

POST /_query/async/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=/stop

Request

edit

POST /_query/async/<query_id>/stop

Prerequisites

edit
  • If the Elasticsearch security features are enabled, only the authenticated user that submitted the original query request can stop the query.

Path parameters

edit
<query_id>

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

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.

Was this helpful?
Feedback