Clear scroll APIedit
Clears the search context and results for a scrolling search.
DELETE /_search/scroll
{
"scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}
Path parametersedit
-
<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_idrequest body parameter.
Query parametersedit
-
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_idrequest body parameter.
Request bodyedit
Response bodyedit
-
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.