Clear scroll API

Clear scroll API

Clears the search context and results for a scrolling search.

  1. DELETE /_search/scroll
  2. {
  3.   "scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
  4. }

Request

DELETE /_search/scroll/<scroll_id> [7.0.0] Deprecated in 7.0.0.

DELETE /_search/scroll

Path parameters

<scroll_id>

[7.0.0] Deprecated in 7.0.0. (Optional, string) Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use _all.

Scroll IDs can be long. We recommend only specifying scroll IDs using the scroll_id request body parameter.

Query parameters

scroll_id

[7.0.0] Deprecated in 7.0.0. (Optional, string) Comma-separated list of scroll IDs to clear. To clear all scroll IDs, use _all.

Scroll IDs can be long. We recommend only specifying scroll IDs using the scroll_id request body parameter.

Request body

scroll_id

(Required, string or array of strings) Scroll IDs to clear. To clear all scroll IDs, use _all.

Response body

succeeded

(Boolean) If true, the request succeeded. This does not indicate whether any scrolling search requests were cleared.

num_freed

(integer) Number of scrolling search requests cleared.