Important
There is now an UptimeKuma core integration in HomeAssistant. It is recommended to migrate to that integration since I will no longer be updating this one.
I'm nore than glad to retire the project as it did take a reasonable amount of time and continuous support for non-technical users. If you would like to drop a token of appreciation, you can do so here.
For details on switching to the core integration, see comment.
This integration exposes UptimeKuma monitors in HomeAssistant. Two sensors are created for each UptimeKuma monitor:
- Binary Sensor (On/Off)
- Sensor (State of UptimeKuma monitor)
Installation is done like any other Home Assistant HACS integration.
In order to setup this integration you will need:
- A Home Assistant instance with HACS installed.
- An instance of UptimeKuma
Search for "Uptime Kuma" in the HACS store. If you don't see it there, you can add this repository url as a HACS custom repository.
After installation, setup the integration via the web UI like any other integration. When prompted, provide the following:
- URL: Your UptimeKuma instance url (i.e. https://myuptimekuma.mydomain.com without a trailing slash)
- Port: (Generally 443 if running behind reverse proxy)
- User: Your uptimekuma Username
- Password: API Key (UptimeKuma > Settings > API Keys)
- Verify SSL: (Generally checked)
- URL: Your UptimeKuma instance url (i.e. http://xxx.xxx.xxx.xxx)
- Note: make sure there is NO trailing slash at the end of the url
- Port : 3001
- User: Your uptimekuma Username
- Password: API Key (UptimeKuma > Settings > API Keys)
- Verify SSL: Unchecked
If you are having issues connecting, make sure you can successfully connect to http(s)://your_uptimekuma.url/metrics using a private browser window.
There have also been reports of non-ssl instances not being entirely reliable. It is recommended to use a valid SSL certificate. This is made easy by projects like NGINXProxyManager, Traefik, Caddy, and others.
Contributions are welcome!