Browse documentation

Pharos / Docs / v1.0.1

Uptime Kuma

Updated 2026-10-22 · Pharos 1.0.1

Pharos accepts component updates through its REST API and success pings through its heartbeat endpoint. A Kuma push monitor receives heartbeats; it is not, by itself, an outgoing bridge to Pharos.

Webhook endpoint. Kuma’s Webhook notification can set a component directly: post it to /api/v1/integrations/kuma/{component} with an API token that can write, sent as Authorization: Bearer. Up sets Operational, down sets Major outage, maintenance sets Under maintenance and pending changes nothing. Use a component without a check of its own. Kuma’s test notification carries no heartbeat status and is refused; check the connection with a real monitor change. Under Integrations & API → Bring in the guide shows the address for each component. A component fed this way gets its uptime counted from the status Kuma reports, see Uptime.

Heartbeat. Alternatively, supply and test an adapter that reports successful checks periodically, or a workflow that updates Pharos through the API. A notification sent only when status changes is not a periodic heartbeat.

See API and tokens and heartbeat checks for the receiving endpoints. Verify failure, recovery and loss of the adapter before using this in production.