rest-api-spec/api/scroll.json


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

{
  "scroll": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html",
    "methods": ["GET", "POST"],
    "url": {
      "path": "/_search/scroll",
      "paths": ["/_search/scroll", "/_search/scroll/{scroll_id}"],
      "parts": {
        "scroll_id": {
          "type" : "string",
          "description" : "The scroll ID"
        }
      },
      "params": {
        "scroll": {
          "type" : "duration",
          "description" : "Specify how long a consistent view of the index should be maintained for scrolled search"
        },
        "scroll_id": {
          "type" : "string",
          "description" : "The scroll ID for scrolled search"
        }
      }
    },
    "body": {
      "description": "The scroll ID if not passed by URL or query parameter."
    }
  }
}