No results
4
Uptime Kuma
Codex edited this page 2026-05-22 14:12:47 -07:00
Uptime Kuma
Dashboard Status
This module is live. The dashboard reads a public Uptime Kuma status page and displays monitor nice names, status lights, links, and recent historical status ticks.
Admin Fields
Status JSON URL
What To Use
Use the public status page URL or its matching JSON endpoint. If your status page is:
https://uptime.example.com/status/homelab
you can usually enter that URL directly. The dashboard tries compatible public status-page endpoints such as:
/api/status-page/<slug>
/api/status-page/heartbeat/<slug>
How To Find It
- Open Uptime Kuma.
- Go to
Status Pages. - Open the status page you want the dashboard to summarize.
- Copy the public status page URL.
- Save it as
Status JSON URLin the dashboard.
What The Card Shows
- Nice monitor name.
- Current status light.
- Clickable monitor name when Uptime Kuma exposes a URL.
- Up to 72 recent heartbeat ticks from Uptime Kuma when the status page exposes heartbeat history.
- Browser-local fallback ticks when the public endpoint only exposes current status.
The dashboard intentionally hides monitor type and raw URL in the main card to keep the view glanceable.
Test From The Docker Host
curl -fsSL 'https://uptime.example.com/api/status-page/homelab'
curl -fsSL 'https://uptime.example.com/api/status-page/heartbeat/homelab'
A successful response is JSON. If you see HTML, a login page, or a reverse-proxy error, the URL is not the endpoint the dashboard needs.
Common Problems
404: the slug is wrong or the status page is not available at that base URL.403or login HTML: the status page is private or protected by SSO/basic auth.- Missing monitor names: verify the public status-page endpoint returns monitor metadata, not only heartbeat data.
ENOTFOUND: the dashboard container cannot resolve the hostname.certificateerrors: the HTTPS certificate is not trusted by Node inside the container.
Sources
- Uptime Kuma internal API wiki: https://github.com/louislam/uptime-kuma/wiki/Internal-API