Clear a scrolling search

DELETE /_search/scroll/{scroll_id}
Api key auth Basic auth Bearer auth

Clear the search context and results for a scrolling search.

External documentation

Path parameters

  • scroll_id string | array[string] Required 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.

application/json

Body

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • 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.
DELETE /_search/scroll/{scroll_id} 
curl \
 --request DELETE http://api.example.com/_search/scroll/{scroll_id} \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"":"string"}'
Request examples 
{
  "": "string"
}
Response examples (200) 
{
  "succeeded": true,
  "num_freed": 42.0
}