Returns the health status of the Makaira API. This endpoint is publicly accessible and does not require authentication.
Request
GET /api/heartbeat
Example Request
GET /api/heartbeatResponse
Returns a JSON object with the current API health state.
Response Body
| Field | Type | Description |
|---|---|---|
ok | boolean | true if all required services are healthy, false otherwise. |
Status Codes
| Status | Description |
|---|---|
200 | API is healthy. |
503 | API is not healthy — one or more services are unavailable. |
Example Response (healthy)
{
"ok": true
}Example Response (unhealthy)
{
"ok": false
}