summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/snapshot.create.json
blob: b0608ab78c724ecbd33f9edbceabcf2b67a27dfa (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
{
  "snapshot.create": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html",
    "methods": ["PUT", "POST"],
    "url": {
      "path": "/_snapshot/{repository}/{snapshot}",
      "paths": ["/_snapshot/{repository}/{snapshot}", "/_snapshot/{repository}/{snapshot}/_create"],
      "parts": {
        "repository": {
          "type": "string",
          "required" : true,
          "description": "A repository name"
        },
        "snapshot": {
          "type": "string",
          "required" : true,
          "description": "A snapshot name"
        }
      },
      "params": {
        "master_timeout": {
          "type" : "time",
          "description" : "Explicit operation timeout for connection to master node"
        },
        "wait_for_completion": {
          "type": "boolean",
          "description": "Should this request wait until the operation has completed before returning",
          "default": false
        }
      }
    },
    "body" : {
      "description" : "The snapshot definition",
      "required" : false
    }
  }
}