Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Provide incidents via API #653

Closed
hypervtechnics opened this issue Oct 11, 2021 · 5 comments
Closed

[Feature Request] Provide incidents via API #653

hypervtechnics opened this issue Oct 11, 2021 · 5 comments
Labels
area:api concearning the api or automation area:incidents Incidents shown in the status pages feature-request Request for new features to be added

Comments

@hypervtechnics
Copy link

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.

@hypervtechnics hypervtechnics added the feature-request Request for new features to be added label Oct 11, 2021
@RisedSky
Copy link
Contributor

RisedSky commented Oct 11, 2021

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

@deefdragon
Copy link
Contributor

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

@hypervtechnics
Copy link
Author

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

@meichthys
Copy link

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?

@deefdragon
Copy link
Contributor

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

@CommanderStorm CommanderStorm added area:incidents Incidents shown in the status pages area:api concearning the api or automation labels Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api concearning the api or automation area:incidents Incidents shown in the status pages feature-request Request for new features to be added
Projects
None yet
Development

No branches or pull requests

5 participants