New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Clear SQL cursor API Get async SQL search API »
Elastic Docs ›Elasticsearch Guide [8.10] ›REST APIs ›SQL APIs

Delete async SQL search API

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Delete async SQL search API

edit

Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.

response = client.sql.delete_async(
  id: 'FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM='
)
puts response
DELETE _sql/async/delete/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
Copy as curlTry in Elastic 

Request

edit

DELETE _sql/async/delete/<search_id>

Prerequisites

edit

  • If the Elasticsearch security features are enabled, only the following users can use this API to delete a search:

    • Users with the cancel_task cluster privilege
    • The user who first submitted the search

Limitations

edit

See SQL Limitations.

Path parameters

edit
<search_id>
(Required, string) Identifier for the search.
« Clear SQL cursor API Get async SQL search API »
Was this helpful?
Feedback