cluster.state.json

{
  "cluster.state": {
    "documentation": {
      "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.html",
      "description": "Returns a comprehensive information about the state of the cluster."
    },
    "stability": "stable",
    "visibility": "public",
    "headers": {
      "accept": ["application/json"]
    },
    "url": {
      "paths": [
        {
          "path": "/_cluster/state",
          "methods": ["GET"]
        },
        {
          "path": "/_cluster/state/{metric}",
          "methods": ["GET"],
          "parts": {
            "metric": {
              "type": "list",
              "options": [
                "_all",
                "blocks",
                "metadata",
                "nodes",
                "routing_table",
                "routing_nodes",
                "master_node",
                "version"
              ],
              "description": "Limit the information returned to the specified metrics"
            }
          }
        },
        {
          "path": "/_cluster/state/{metric}/{index}",
          "methods": ["GET"],
          "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",
                "routing_nodes",
                "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)"
      },
      "wait_for_metadata_version": {
        "type": "number",
        "description": "Wait for the metadata version to be equal or greater than the specified metadata version"
      },
      "wait_for_timeout": {
        "type": "time",
        "description": "The maximum time to wait for wait_for_metadata_version before timing out"
      },
      "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", "hidden", "none", "all"],
        "default": "open",
        "description": "Whether to expand wildcard expression to concrete indices that are open, closed or both."
      }
    }
  }
}