homepage/docs/widgets/services/uptime-kuma.md

---
title: Uptime Kuma
description: Uptime Kuma Widget Configuration
---

Learn more about [Uptime Kuma](https://github.com/louislam/uptime-kuma).

As Uptime Kuma does not yet have a full API the widget uses data from a single "status page". As such you will need a status page setup with a group of monitored sites, which is where you get the slug (the url without the `/status/` portion). E.g. if your status page is URL http://uptimekuma.host/status/statuspageslug, insert `slug: statuspageslug`.

Allowed fields: `["up", "down", "uptime", "incident"]`.

```yaml
widget:
  type: uptimekuma
  url: http://uptimekuma.host.or.ip:port
  slug: statuspageslug
```
add mkdocs 2023-09-29 21:01:11 +03:00			`---`
			`title: Uptime Kuma`
			`description: Uptime Kuma Widget Configuration`
			`---`

Make service links less weird 2024-01-24 14:27:47 -08:00			`Learn more about [Uptime Kuma](https://github.com/louislam/uptime-kuma).`
Documentation: add project links to service widget docs (#2737) 2024-01-22 13:26:15 -05:00
Documentation: clarify uptime kuma slug (#3345) --------- Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com> 2024-04-22 12:33:35 -07:00			As Uptime Kuma does not yet have a full API the widget uses data from a single "status page". As such you will need a status page setup with a group of monitored sites, which is where you get the slug (the url without the `/status/` portion). E.g. if your status page is URL http://uptimekuma.host/status/statuspageslug, insert `slug: statuspageslug`.
add mkdocs 2023-09-29 21:01:11 +03:00
			Allowed fields: `["up", "down", "uptime", "incident"]`.

			```yaml
			`widget:`
Run pre-commit hooks over existing codebase Co-Authored-By: Ben Phelps <ben@phelps.io> 2023-10-17 23:26:55 -07:00			`type: uptimekuma`
			`url: http://uptimekuma.host.or.ip:port`
			`slug: statuspageslug`
add mkdocs 2023-09-29 21:01:11 +03:00			```