[Feature Request] Provide incidents via API #383

Closed
opened 2026-02-28 01:44:41 -05:00 by deekerman · 5 comments
Owner

Originally created by @hypervtechnics on GitHub (Oct 11, 2021).

Is your feature request related to a problem? Please describe.
I am using Homer as a landing page. To keep things dry I'd like Uptime-Kuma to also serve the active incident to the Homer site. The integration on the homer site is possible: https://github.com/bastienwirtz/homer/blob/main/docs/tips-and-tricks.md#get-the-news-headlines-in-homer . But Uptime-Kuma does not expose the required information as a REST API so that Homer can fetch that information.

Describe the solution you'd like
Provide a REST API endpoint which provides the active incident if there is one.

Describe alternatives you've considered
None so far. Currently I'll just copy and paste the message.

Originally created by @hypervtechnics on GitHub (Oct 11, 2021). **Is your feature request related to a problem? Please describe.** I am using Homer as a landing page. To keep things dry I'd like Uptime-Kuma to also serve the active incident to the Homer site. The integration on the homer site is possible: https://github.com/bastienwirtz/homer/blob/main/docs/tips-and-tricks.md#get-the-news-headlines-in-homer . But Uptime-Kuma does not expose the required information as a REST API so that Homer can fetch that information. **Describe the solution you'd like** Provide a REST API endpoint which provides the active incident if there is one. **Describe alternatives you've considered** None so far. Currently I'll just copy and paste the message.
Author
Owner

@RisedSky commented on GitHub (Oct 11, 2021):

Maybe you can check if /metrics can give the information you request ?

@RisedSky commented on GitHub (Oct 11, 2021): Maybe you can check if `/metrics` can give the information you request ?
Author
Owner

@deefdragon commented on GitHub (Oct 11, 2021):

This falls under #118 as a duplicate. Please comment there so we can build a list of what endpoints are desired in one place.

@deefdragon commented on GitHub (Oct 11, 2021): This falls under #118 as a duplicate. Please comment there so we can build a list of what endpoints are desired in one place.
Author
Owner

@hypervtechnics commented on GitHub (Oct 11, 2021):

@RisedSky I just checked. It does not give this information. But thanks for the tip.
@deefdragon Thanks for the heads up

@hypervtechnics commented on GitHub (Oct 11, 2021): @RisedSky I just checked. It does not give this information. But thanks for the tip. @deefdragon Thanks for the heads up
Author
Owner

@meichthys commented on GitHub (Oct 22, 2021):

Maybe you can check if /metrics can give the information you request ?

Is 'metrics' a part of the undocumented api that we should not rely on? Or is this officially for public consumption?

@meichthys commented on GitHub (Oct 22, 2021): > Maybe you can check if `/metrics` can give the information you request ? Is 'metrics' a part of the undocumented api that we should not rely on? Or is this officially for public consumption?
Author
Owner

@deefdragon commented on GitHub (Oct 22, 2021):

@meichthys /metrics outputs standard prometheus-compatable metrics for consumption.
see https://github.com/louislam/uptime-kuma/wiki/Prometheus-Integration

@deefdragon commented on GitHub (Oct 22, 2021): @meichthys /metrics outputs standard prometheus-compatable metrics for consumption. see https://github.com/louislam/uptime-kuma/wiki/Prometheus-Integration
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#383
No description provided.