OpenSearch/rest-api-spec/api/indices.recovery.json
Andrew Selden 89e45fde9c Recovery API
Adds a new API endpoint at /_recovery as well as to the Java API. The
recovery API allows one to see the recovery status of all shards in the
cluster. It will report on percent complete, recovery type, and which
files are copied.

Closes #4637
2014-03-20 10:13:30 -07:00

34 lines
1.3 KiB
JSON

{
"indices.recovery" : {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html",
"methods": ["GET"],
"url": {
"path": "/_recovery",
"paths": ["/_recovery", "/{index}/_recovery"],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
}
},
"params": {
"detailed" : {
"type": "boolean",
"description": "Whether to display detailed information about shard recovery",
"default": false
},
"active_only" : {
"type": "boolean",
"description": "Display only those recoveries that are currently on-going",
"default": false
},
"human": {
"type": "boolean",
"description": "Whether to return time and byte values in human-readable format.",
"default": false
}
}
},
"body": null
}
}