health
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
Request
- Base URLhttp://localhost:8080
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Response
Service is healthy
unknown required
Changes
No recorded changes to this operation across all 10 revisions of this API.