Uptime-Kuma-API
Uptime-Kuma-API is a self-hosted REST API wrapper for Uptime Kuma that lets scripts and other services interact with a running monitoring instance for…
Platform availability
Available on 1 of 10 platforms
- Unraid
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server (not listed)
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
27/100 Low
- Maintained
- 0last commit 1199 days ago
- Popular
- 49282 GitHub stars
- Easy to install
- 351 install platform, install notes, Docker image
- Light to run
- 801 GB minimum RAM, runs on ARM
- Security check
- 54 serious findings, 8 minor, CI, tests
Security check: 4 serious findings
- Uses anyio 3.6.1, which has a known critical vulnerability (PyPI)
- Uses certifi 2022.9.24, which has a known critical vulnerability (PyPI)
- Uses h11 0.14.0, which has a known critical vulnerability (PyPI)
- Uses pyjwt 1.7.1, which has a known critical vulnerability (PyPI)
Automated checks on commit 2402078, 3 Nov 2026. Not an audit.
Availability: platform listings confirmed today, links checked 53 days ago
- GitHub stars
- 282
- Open issues
- 44
- Last commit
- 2023-08-10
- Latest release
- v1.2.2
- Activity
- stale
Checked 20 days ago - source: GitHub (MedAziz11/Uptime-Kuma-Web-API)
Resources & Compatibility
Minimum requirements: 1 GB RAM. ARM (e.g. Raspberry Pi) is supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Install the Python helper package Run pip install uptime-kuma-api in your terminal; pip is the Python package installer. Without it, your scripts or automations cannot talk to Uptime Kuma through this API. source
- Create the admin login once Before using other features, check if the server needs first-run setup and, if so, call setup() with your chosen username and password. This creates the administrator account; if it is skipped, Uptime Kuma may be unfinished and you may not be able to sign in. source
- Add 2FA for safer logins For extra security, use prepare_2fa with your password and scan the returned setup URI in an authenticator app. Two-factor (2FA) makes someone else need a second login code in addition to your password. source
- Required environment variables Set KUMA_SERVER, KUMA_USERNAME, KUMA_PASSWORD, and ADMIN_PASSWORD so the API can reach Uptime Kuma and protect itself. source
Fetched 37 days ago - each note links to its source
Variants
Alternatives (12)
- Better Stack - AI-driven monitoring platform providing incident management, real-time logs, uptime, traces, error tracking, infrastructure analytics, and…
- HetrixTools
- Kener
- PHP Server Monitor - PHP Server Monitor checks whether your websites and servers are up and running.
- PingKit Agent - PingKit Agent watches your own network and alerts PingKit on your iPhone when the internet goes down, a new device joins or a device goes o…
- Pingdom - Monitors uptime, downtime, and website performance in real time using synthetic and real user data, with instant alerts, customizable repor…
- Pulsetic - Get instant website downtime alerts via phone call, SMS, email, or Slack, monitor global uptime in real time, create status pages, and mana…
- StablePing
- Statping-ng - Statping-ng is an open-source status page server and maintained fork of Statping that monitors websites, applications, and other services,…
- StatusCake - Tracks uptime and performance for up to 10 websites, sends alerts via multiple channels, offers root cause analysis, and a free plan with p…
- Tianji - Tianji is a self-hosted website analytics and uptime monitoring platform that combines visitor traffic insights, service availability check…
- Uptime Kuma - Uptime Kuma is an easy-to-use, self-hosted monitoring tool that tracks the availability of websites, APIs, network services, and Docker con…
Checked 41 days ago - source: AlternativeTo
Common questions
Why might the API fail to connect to my Uptime Kuma instance?
You must define the required KUMA_SERVER, KUMA_USERNAME, KUMA_PASSWORD, and ADMIN_PASSWORD environment variables. In the Docker Compose example, start Uptime Kuma first, create the Kuma username and password, then re-run the compose file.
How do I authenticate requests to the REST API?
POST to /login/access-token with username=admin and the ADMIN_PASSWORD value to obtain an access token. Send the returned access token in the Authorization header as Bearer ${TOKEN}.
Where does the wrapper store its data?
It uses a small SQLite database for multi-user API data. In the Docker Compose example, that data is persisted in the api volume mounted at /db.
Which optional environment variables control token and JWT behavior?
ACCESS_TOKEN_EXPIRATION sets how many minutes an access token should be valid, defaulting to 8 days. SECRET_KEY is the secret value used to encode JWTs.
Answers sourced from github.com
Community
- Uptime Kuma | Cloudron Forum (forum)
- can the api do anything? : r/UptimeKuma - Reddit (reddit)
- REST API Work-Arounds : r/UptimeKuma - Reddit (reddit)
- Uptime Kuma - self-hosted monitoring tool like "Uptime Robot". - Reddit (reddit)
- UptimeKuma - Reddit (reddit)
- Uptime kuma keywords monitoring - FAQ - Storj Community Forum (official) (forum)
Collected 48 days ago - public community threads