Skip to main content
GET
/
cluster-health
Cluster state endpoint
curl --request GET \
  --url https://api.example.com/cluster-health
{
  "cluster_name": "<string>",
  "metadata_cluster_health": "<unknown>"
}

Response

Cluster health information

Cluster health information

cluster_name
string
required

Cluster name

metadata_cluster_health
object

Embedded metadata cluster health if it was enabled