summaryrefslogtreecommitdiff
path: root/rest-api-spec/api/cluster.state.json
diff options
context:
space:
mode:
Diffstat (limited to 'rest-api-spec/api/cluster.state.json')
-rw-r--r--rest-api-spec/api/cluster.state.json44
1 files changed, 44 insertions, 0 deletions
diff --git a/rest-api-spec/api/cluster.state.json b/rest-api-spec/api/cluster.state.json
new file mode 100644
index 0000000..dcf0182
--- /dev/null
+++ b/rest-api-spec/api/cluster.state.json
@@ -0,0 +1,44 @@
+{
+ "cluster.state": {
+ "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-state.html",
+ "methods": ["GET"],
+ "url": {
+ "path": "/_cluster/state",
+ "paths": [
+ "/_cluster/state",
+ "/_cluster/state/{metric}",
+ "/_cluster/state/{metric}/{index}"
+ ],
+ "parts": {
+ "index": {
+ "type" : "list",
+ "description" : "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
+ },
+ "metric" : {
+ "type" : "list",
+ "options" : ["_all", "blocks", "metadata", "nodes", "routing_table", "master_node", "version"],
+ "description" : "Limit the information returned to the specified metrics"
+ }
+ },
+ "params": {
+ "local": {
+ "type": "boolean",
+ "description": "Return local information, do not retrieve the state from master node (default: false)"
+ },
+ "master_timeout": {
+ "type": "time",
+ "description": "Specify timeout for connection to master"
+ },
+ "index_templates": {
+ "type": "list",
+ "description": "A comma separated list to return specific index templates when returning metadata"
+ },
+ "flat_settings": {
+ "type": "boolean",
+ "description": "Return settings in flat format (default: false)"
+ }
+ }
+ },
+ "body": null
+ }
+}