Health

Unauthenticated liveness check for the Pharlo API. Useful for status-page integrations, uptime monitors, and Kubernetes-style readiness probes.

Base URL: https://pharlo.io

This endpoint does not require an Authorization header — it is intentionally public so external monitors can poll it without managing credentials. It is also not billed.

`GET /api/v1/health`

Returns 200 OK with a tiny JSON body when the API is up and able to serve traffic. The response indicates only that the HTTP layer is alive — downstream dependencies (database, queue, ClickHouse) are checked by separate internal probes and are not reflected here.

Example request

curl https://pharlo.io/api/v1/health

Response `200 OK`

{
  "status": "ok",
  "timestamp": "2026-05-18T12:00:00Z"
}

Field	Type	Description
`status`	string	Always `ok` when the endpoint responds with `200`
`timestamp`	ISO 8601	Server time at the moment of the response — useful for sanity-checking clock skew

Error responses

If the API is degraded or unreachable, you will typically receive a transport-level error (connection refused, TCP timeout) rather than a structured JSON body. Treat any non-200 response as "unhealthy" in your monitor.

Recommended usage

Uptime monitors: poll every 30–60 seconds. Anything more frequent is wasteful.
Status pages: surface the latest timestamp to confirm the response is fresh.
CI smoke tests: hit /health before running deployment-sensitive integration tests.

Do not use /health as a substitute for monitoring your own integration's health — for that, watch the webhook delivery log and your assignment status transitions.

Billing Overview