IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Clear scroll API
editClear scroll API
editClears the search context and results for a scrolling search.
resp = client.clear_scroll( scroll_id="DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==", ) print(resp)
response = client.clear_scroll( body: { scroll_id: 'DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==' } ) puts response
res, err := es.ClearScroll( es.ClearScroll.WithBody(strings.NewReader(`{ "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==" }`)), ) fmt.Println(res, err)
const response = await client.clearScroll({ scroll_id: "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==", }); console.log(response);
DELETE /_search/scroll { "scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==" }
Path parameters
edit-
<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
edit-
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
editResponse body
edit-
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.