summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/cluster.health.json
diff options
context:
space:
mode:
authorHilko Bengen <bengen@debian.org>2014-06-07 12:02:12 +0200
committerHilko Bengen <bengen@debian.org>2014-06-07 12:02:12 +0200
commitd5ed89b946297270ec28abf44bef2371a06f1f4f (patch)
treece2d945e4dde69af90bd9905a70d8d27f4936776 /rest-api-spec/api/cluster.health.json
downloadelasticsearch-d5ed89b946297270ec28abf44bef2371a06f1f4f.tar.gz
Imported Upstream version 1.0.3upstream/1.0.3
Diffstat (limited to 'rest-api-spec/api/cluster.health.json')
-rw-r--r--rest-api-spec/api/cluster.health.json55
1 files changed, 55 insertions, 0 deletions
diff --git a/rest-api-spec/api/cluster.health.json b/rest-api-spec/api/cluster.health.json
new file mode 100644
index 0000000..9d679d6
--- /dev/null
+++ b/rest-api-spec/api/cluster.health.json
@@ -0,0 +1,55 @@
+{
+ "cluster.health": {
+ "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-health.html",
+ "methods": ["GET"],
+ "url": {
+ "path": "/_cluster/health",
+ "paths": ["/_cluster/health", "/_cluster/health/{index}"],
+ "parts": {
+ "index": {
+ "type" : "string",
+ "description" : "Limit the information returned to a specific index"
+ }
+ },
+ "params": {
+ "level": {
+ "type" : "enum",
+ "options" : ["cluster","indices","shards"],
+ "default" : "cluster",
+ "description" : "Specify the level of detail for returned information"
+ },
+ "local": {
+ "type" : "boolean",
+ "description" : "Return local information, do not retrieve the state from master node (default: false)"
+ },
+ "master_timeout": {
+ "type" : "time",
+ "description" : "Explicit operation timeout for connection to master node"
+ },
+ "timeout": {
+ "type" : "time",
+ "description" : "Explicit operation timeout"
+ },
+ "wait_for_active_shards": {
+ "type" : "number",
+ "description" : "Wait until the specified number of shards is active"
+ },
+ "wait_for_nodes": {
+ "type" : "string",
+ "description" : "Wait until the specified number of nodes is available"
+ },
+ "wait_for_relocating_shards": {
+ "type" : "number",
+ "description" : "Wait until the specified number of relocating shards is finished"
+ },
+ "wait_for_status": {
+ "type" : "enum",
+ "options" : ["green","yellow","red"],
+ "default" : null,
+ "description" : "Wait until cluster is in a specific state"
+ }
+ }
+ },
+ "body": null
+ }
+}