# 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 automation and integrations. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/801/uptime-kuma-api

## Description

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 automation and integrations.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

23/100 (Low), based on 3 of 4 factors.
- Maintained: 0 (last commit 1169 days ago)
- Popular: 49 (280 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/u/medaziz11
- GitHub: https://github.com/MedAziz11/Uptime-Kuma-Web-API
- Unraid: https://ca.unraid.net/apps/uptime-kuma-api-1sc8jrc1072z90?q=Uptime-Kuma-API

## 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.

## Alternatives

- 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.
- 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…
- Uptime.com

---
Source: Our Local Host (https://ourlocalhost.com/app/801/uptime-kuma-api), the self-hosted and open-source app directory.