OpenSearch/rest-api-spec/api/snapshot.create.json

38 lines
1.1 KiB
JSON

{
"snapshot.create": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/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
}
}
}