elasticsearch/docs/reference/sql/apis/delete-async-sql-search-api.asciidoc
James Rodewig 07ac8818b6
[DOCS] Remove testenv annotations from doc snippet tests (#80023) (#80458)
Removes `testenv` annotations and related code. These annotations originally let you skip x-pack snippet tests in the docs. However, that's no longer possible.

Relates to #79309, #31619
# Conflicts:
#	docs/reference/ml/df-analytics/apis/get-trained-model-deployment-stats.asciidoc
#	docs/reference/ml/df-analytics/apis/infer-trained-model-deployment.asciidoc
#	docs/reference/ml/df-analytics/apis/put-trained-model-definition-part.asciidoc
#	docs/reference/ml/df-analytics/apis/put-trained-model-vocabulary.asciidoc
#	docs/reference/ml/df-analytics/apis/start-trained-model-deployment.asciidoc
#	docs/reference/ml/df-analytics/apis/stop-trained-model-deployment.asciidoc
#	docs/reference/slm/apis/slm-delete.asciidoc
#	docs/reference/slm/apis/slm-execute-retention.asciidoc
#	docs/reference/slm/apis/slm-execute.asciidoc
#	docs/reference/slm/apis/slm-get-status.asciidoc
#	docs/reference/slm/apis/slm-get.asciidoc
#	docs/reference/slm/apis/slm-start.asciidoc
#	docs/reference/slm/apis/slm-stats.asciidoc
#	docs/reference/slm/apis/slm-stop.asciidoc
#	docs/reference/sql/endpoints/client-apps/tableau-desktop.asciidoc
#	docs/reference/sql/endpoints/client-apps/tableau-server.asciidoc
2021-11-05 19:41:54 -04:00

40 lines
1.1 KiB
Text

[role="xpack"]
[[delete-async-sql-search-api]]
=== Delete async SQL search API
++++
<titleabbrev>Delete async SQL search</titleabbrev>
++++
Deletes an <<sql-async,async SQL search>> or a <<sql-store-searches,stored
synchronous SQL search>>. If the search is still running, the API cancels it.
[source,console]
----
DELETE _sql/async/delete/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=
----
// TEST[skip: no access to search ID]
[[delete-async-sql-search-api-request]]
==== {api-request-title}
`DELETE _sql/async/delete/<search_id>`
[[delete-async-sql-search-api-prereqs]]
==== {api-prereq-title}
* If the {es} {security-features} are enabled, only the following users can
use this API to delete a search:
** Users with the `cancel_task` <<privileges-list-cluster,cluster privilege>>
** The user who first submitted the search
[[delete-async-sql-search-api-limitations]]
===== Limitations
See <<sql-limitations>>.
[[delete-async-sql-search-api-path-params]]
==== {api-path-parms-title}
`<search_id>`::
(Required, string) Identifier for the search.