1234567891011121314151617181920212223242526272829303132333435363738394041 |
- [role="xpack"]
- [testenv="basic"]
- [[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.
|