OpenSearch/rest-api-spec/api/cluster.state.json
Alexander Reelsen d4fcf23057 Cluster State API: Remove index template filtering
The possibility of filtering for index templates in the cluster state API
had been introduced before there was a dedicated index templates API. This
commit removes this support from the cluster state API, as it was not really
clean, requiring you to specify the metadata and the index templates.

Closes #4954
2014-05-05 14:54:14 +02:00

41 lines
1.3 KiB
JSON

{
"cluster.state": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/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"
},
"flat_settings": {
"type": "boolean",
"description": "Return settings in flat format (default: false)"
}
}
},
"body": null
}
}