API functionality

### Discussed in https://github.com/louislam/uptime-kuma/discussions/96 Originally posted by **TheGuyDanish** July 12, 2021 I'd love to see the ability to retrieve, update, remove or add monitors via API calls. Maybe using an API key that's tied to the user. In a way that when spinning up a new docker container or doing an automated workflow like Terraform, the new device could be added to the software automatically.

GitHubToolAISource
0Sign in to voteCopy link

FL score

75

out of 100

Verdict

BUILD

low confidence

Competition

No competitor data yet

Trend

No signal yet

Adding API functionality to Uptime Kuma would significantly empower dev/ops teams with automation, but requires validating a monetization strategy for a solo builder.

The pain

Dev/ops teams using Uptime Kuma with dynamic infrastructure (Docker, Terraform) suffer from manual, repetitive, and error-prone monitor configuration, hindering their ability to fully automate their CI/CD pipelines and infrastructure-as-code deployments.

The gap

Uptime Kuma, an otherwise excellent self-hosted monitoring tool, currently lacks programmatic API access to manage monitors. This forces users to either manual processes or brittle custom scripts, creating a clear gap for automation-focused users who would otherwise integrate it into their modern infrastructure workflows.

Build angle

Develop a robust, secure API for Uptime Kuma monitor management. This could be offered as a standalone paid integration service, a premium 'Uptime Kuma Pro' self-hosted offering with API access, or via a SaaS wrapper around the open-source core.

Strengths

  • Explicit user demand from the target audience.
  • Addresses a specific and recurring pain point (automation) for a technical user base.
  • Leverages an existing, popular open-source project (Uptime Kuma).
  • High value proposition for time-saving and efficiency.
  • The market for infrastructure automation and monitoring is growing.

Risks

  • Monetization strategy for an open-source project feature is unclear and needs validation.
  • Building a secure, robust, and well-integrated API can be complex for a solo builder.
  • Reliance on the Uptime Kuma project's architecture and future development.
  • Potential for the core Uptime Kuma project to add its own API, potentially devaluing a separate product.

Next steps

  1. Conduct surveys or interviews with Uptime Kuma users (especially those involved in dev/ops, SRE, or IaC) to gauge specific API needs and willingness to pay for automation features.
  2. Research existing paid APIs/integrations in the self-hosted monitoring space for pricing models.
  3. Explore potential partnerships or contributions to the Uptime Kuma project to become the official API provider, or develop a clear premium offering that complements the open-source version.
  4. Define the minimum viable feature set for an API that provides immediate value for automation, focusing on CRUD operations for monitors.

Questions about this idea?

FlyBot reads the scoring and gives you a second opinion on “API functionality”.

Open FlyBot