Health Check API Reference
The Health API is a public endpoint which gives info on the server health.
All requests are
GET requests to the
/healthz endpoint. There's also
/hasura/healthz available as an alternative, which mirrors
GET /healthz?strict=false HTTP/1.1
|strict||false||boolean||If set to |
Depending on the server health status any of the following responses can be returned:
|Server condition||HTTP Status||Message|
|Serving requests but some Metadata objects are inconsistent/not-available||200||WARN: inconsistent objects in schema|
|Serving requests but some Metadata objects are inconsistent/not-available||500||ERROR: inconsistent objects in schema|
If there are Metadata inconsistencies, you should use the Hasura Console or the get_inconsistent_metadata Metadata API to find out what the inconsistent objects are and resolve them.
HTTP/1.1 200 OK
Disabling Health Check API
healthz API endpoint is public and cannot be disabled.