summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/bulk.json
blob: aefbee70152727b45d00ad6bd46ad6b0864eb0fc (plain)
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
  "bulk": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-bulk.html",
    "methods": ["POST", "PUT"],
    "url": {
      "path": "/_bulk",
      "paths": ["/_bulk", "/{index}/_bulk", "/{index}/{type}/_bulk"],
      "parts": {
        "index": {
          "type" : "string",
          "description" : "Default index for items which don't provide one"
        },
        "type": {
          "type" : "string",
          "description" : "Default document type for items which don't provide one"
        }
      },
      "params": {
        "consistency": {
          "type" : "enum",
          "options" : ["one", "quorum", "all"],
          "description" : "Explicit write consistency setting for the operation"
        },
        "refresh": {
          "type" : "boolean",
          "description" : "Refresh the index after performing the operation"
        },
        "replication": {
          "type" : "enum",
          "options" : ["sync","async"],
          "default" : "sync",
          "description" : "Explicitely set the replication type"
        },
        "routing": {
          "type" : "string",
          "description" : "Specific routing value"
        },
        "timeout": {
          "type" : "time",
          "description" : "Explicit operation timeout"
        },
        "type": {
          "type" : "string",
          "description" : "Default document type for items which don't provide one"
        },
        "timeout": {
          "type" : "time",
          "description" : "Explicit operation timeout"
        }
      }
    },
    "body": {
      "description" : "The operation definition and data (action-data pairs), separated by newlines",
      "required" : true,
      "serialize" : "bulk"
    }
  }
}