Skip to content
Start free in Cloud

Get system health REST API

GET
/api/admin/system/health
curl --request GET \
--url http://127.0.0.1:25737/api/admin/system/health \
--cookie hk_token=<hk_token>

Returns instance health, database status, worker status, and cluster leader state.

System health

Media typeapplication/json
object
database
string
is_leader
boolean
status
string
workers
string
Examplegenerated
{
"database": "example",
"is_leader": true,
"status": "example",
"workers": "example"
}