Tearleads

GET/

Health check

Operation health.get

Description

Returns ok when the API process is serving requests; load balancers and clients use it as a liveness probe. It needs no session, and a request that carries a body is refused with 413.

Authentication

No session is required.

Responses

200 OK

application/jsonHealthResponse

The health check answer.

1 field
  • messagestringrequired

Other fields are allowed.

Other responses

StatusMeaningBody
413Content Too Large

application/jsonErrorResponse

500Internal Server Error

application/jsonErrorResponse

503Service Unavailable

application/jsonErrorResponse