Clear a scrolling search

DELETE /_search/scroll/{scroll_id}
DELETE /_search/scroll

Auth

Clear the search context and results for a scrolling search.

Path parameters

scroll_id union string | string[] optional deprecated

A comma-separated list of scroll IDs to clear. To clear all scroll IDs, use _all. IMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.

Leave it out to use /_search/scroll.

Request body

scroll_id union oneOf: The scroll IDs to clear. To clear all scroll IDs, use _all.; One of: string[] or string

Responses

application/json

succeeded boolean required: If true, the request succeeded. This does not indicate whether any scrolling search requests were cleared.
num_freed number required: The number of scrolling search requests cleared.

application/json

View as Markdown

Examples

Request Console 1 / 8 languages

Run DELETE /_search/scroll to clear the search context and results for a scrolling search.

Console Kibana Dev Tools

DELETE /_search/scroll
{
  "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
}

JavaScript Elasticsearch JavaScript Client

const response = await client.clearScroll({
  scroll_id: "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
});

Python Elasticsearch Python Client

resp = client.clear_scroll(
    scroll_id="DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
)

curl Shell

curl -X DELETE "$ELASTICSEARCH_URL/_search/scroll" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
  }'

Java Elasticsearch Java Client

client.clearScroll(c -> c
    .scrollId("DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==")
);

C# Elasticsearch .NET Client

var response = await client
    .ClearScrollAsync(d1 => d1
        .ScrollId(new[] { "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==" })
    );

PHP Elasticsearch PHP Client

$resp = $client->clearScroll([
    "body" => [
        "scroll_id" => "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==",
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.clear_scroll(
  body: {
    "scroll_id": "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ=="
  }
)

Response

{
  "succeeded": false,
  "num_freed": 0
}

Generated from the API spec

{
  "succeeded": false,
  "num_freed": 0
}

Generated from the API spec

Path parameters

Request body { }

Responses

Request body