OpenSearch/rest-api-spec/api/cluster.state.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)"
        },
        "ignore_unavailable": {
            "type" : "boolean",
            "description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
        },
        "allow_no_indices": {
            "type" : "boolean",
            "description" : "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
        },
        "expand_wildcards":{
          "type" : "enum",
          "options" : ["open","closed","none","all"],
          "default" : "open",
          "description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
        }
      }
    },
    "body": null
  }
}