Top / Sum Status for a Status Page as API endpoint? #2787

Closed
opened 2026-02-28 03:07:13 -05:00 by deekerman · 3 comments
Owner

Originally created by @Noschvie on GitHub (Nov 13, 2023).

⚠️ Please verify that this bug has NOT been raised before.

  • I checked and didn't find similar issue

🛡️ Security Policy

📝 Describe your problem

Hello,
how can I get the top or sum status of a configured status page as API endpoint? Want to display this sum status inside a smart home visualisation.
Like this <kuma-url>/api/badgePage/:statusPageName/status
Thanks!

📝 Error Message(s) or Log

No response

🐻 Uptime-Kuma Version

1.23.4

💻 Operating System and Arch

Debian 12, amd64

🌐 Browser

Firefox, latest

🐋 Docker Version

Docker version 24.0.6

🟩 NodeJS Version

No response

Originally created by @Noschvie on GitHub (Nov 13, 2023). ### ⚠️ Please verify that this bug has NOT been raised before. - [X] I checked and didn't find similar issue ### 🛡️ Security Policy - [X] I agree to have read this project [Security Policy](https://github.com/louislam/uptime-kuma/security/policy) ### 📝 Describe your problem Hello, how can I get the top or sum status of a configured status page as API endpoint? Want to display this sum status inside a smart home visualisation. Like this `<kuma-url>/api/badgePage/:statusPageName/status` Thanks! ### 📝 Error Message(s) or Log _No response_ ### 🐻 Uptime-Kuma Version 1.23.4 ### 💻 Operating System and Arch Debian 12, amd64 ### 🌐 Browser Firefox, latest ### 🐋 Docker Version Docker version 24.0.6 ### 🟩 NodeJS Version _No response_
deekerman 2026-02-28 03:07:13 -05:00
Author
Owner

@CommanderStorm commented on GitHub (Nov 13, 2023):

Currently, we don't offer an api. See #118 for further details.
The current attempt at adding such a functionality is https://github.com/louislam/uptime-kuma/pull/3854 and might be merged into v2.1 if all goes well.

You can find external tooling which does wrap around our internal web socket endpoints, see https://uptime-kuma-api.readthedocs.io/en/latest/

@CommanderStorm commented on GitHub (Nov 13, 2023): Currently, we don't offer an api. See #118 for further details. The current attempt at adding such a functionality is https://github.com/louislam/uptime-kuma/pull/3854 and might be merged into `v2.1` if all goes well. You can find external tooling which does wrap around our internal web socket endpoints, see https://uptime-kuma-api.readthedocs.io/en/latest/
Author
Owner

@github-actions[bot] commented on GitHub (Feb 14, 2024):

We are clearing up our old help-issues and your issue has been open for 60 days with no activity.
If no comment is made and the stale label is not removed, this issue will be closed in 7 days.

@github-actions[bot] commented on GitHub (Feb 14, 2024): We are clearing up our old `help`-issues and your issue has been open for 60 days with no activity. If no comment is made and the stale label is not removed, this issue will be closed in 7 days.
Author
Owner

@Noschvie commented on GitHub (Feb 14, 2024):

Planned for v2.1

@Noschvie commented on GitHub (Feb 14, 2024): Planned for `v2.1`
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/uptime-kuma#2787
No description provided.