NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

scroll

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

client.scroll({
  scroll_id: string,
  scroll: string,
  scroll_id: string,
  rest_total_hits_as_int: boolean,
  body: object
})

`scroll_id` or `scrollId`	`string` - The scroll ID
`scroll`	`string` - Specify how long a consistent view of the index should be maintained for scrolled search
`scroll_id` or `scrollId`	`string` - The scroll ID for scrolled search
`rest_total_hits_as_int` or `restTotalHitsAsInt`	`boolean` - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
`body`	`object` - The scroll ID if not passed by URL or query parameter.