Health and maintenance
Get the instance's health
Returns whether the instance is serving and the state of each component it depends on. Needs no credential.
GET
Returns the health. status is ok or degraded.
application/json- response
The instance's health: the worst state of its components, and each one's state.
status*stringok: serving normally. degraded: serving, but something is slow, low or unknown. down: something refused.
Value in
"ok""degraded""down"components*Each component checked: reading and writing the database, free disk space and the blob store.
platform_types*The platform types this build no longer ships.
unrecognized_stored_values*Stored values this build does not recognize.
placement?Where the server runs. Present only when it is configured.
version?stringThe build the instance runs, when it is known.
curl -X GET 'http://localhost:8600/health'{ "status": "ok", "components": { "database": { "status": "ok", "latency_ms": 0, "error": "string" }, "database_write": { "status": "ok", "latency_ms": 0, "error": "string" }, "disk": { "status": "ok", "latency_ms": 0, "error": "string" }, "blob_storage": { "status": "ok", "latency_ms": 0, "error": "string" } }, "platform_types": { "retired": 0 }, "unrecognized_stored_values": { "rows": 0, "scanned": true }, "placement": { "region": "string", "location": "string", "country": "string" }, "version": "string"}