OpenSearch/rest-api-spec/api/cluster.health.json

{
  "cluster.health": {
    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/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
  }
}