New

The executive guide to generative AI

Read more
About usPartnersSupport|Login

IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« bulk count »
Elastic Docs ›elasticsearch.js ›7.1 API

clearScroll

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

clearScroll

edit
client.clearScroll([params, [callback]])

Clear the scroll request created by specifying the scroll parameter to search.

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

scrollId

String, String[], Boolean — A comma-separated list of scroll IDs to clear

body

Object, JSON — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

back to top

« bulk count »
Was this helpful?
Feedback