v1
latestOpenAPI 3.1.0Apache-2.02026-07-1783444.0 KBhealth
Health
This function is used to verify that the server is running and responsive. It's typically used by load balancers or monitoring systems to check the health status of the service.
Returns
Returns a static string "OK" to indicate that the server is healthy and functioning properly.
Examples
This function is usually mapped to a GET endpoint, for example:
app.route("/health", get(health_check))
get/health
Response
Service is healthy
{"stackTrail":"paths:/health:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}