Delete async EQL search API

Delete async EQL search API

New API reference

For the most up-to-date API details, refer to EQL APIs.

Deletes an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.

  1. resp = client.eql.delete(
  2. id="FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
  3. )
  4. print(resp)
  1. response = client.eql.delete(
  2. id: 'FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM='
  3. )
  4. puts response
  1. const response = await client.eql.delete({
  2. id: "FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=",
  3. });
  4. console.log(response);
  1. DELETE /_eql/search/FkpMRkJGS1gzVDRlM3g4ZzMyRGlLbkEaTXlJZHdNT09TU2VTZVBoNDM3cFZMUToxMDM=

Request

DELETE /_eql/search/<search_id>

Prerequisites

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

  • See Required fields.

Limitations

See EQL limitations.

Path parameters

<search_id>

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

A search ID is provided in the EQL search API‘s response for an async search. A search ID is also provided if the request’s keep_on_completion parameter is true.