{"id":50356823,"url":"https://github.com/wvogel/uptime-kuma-api","last_synced_at":"2026-05-29T23:04:16.149Z","repository":{"id":349498759,"uuid":"1202571089","full_name":"wvogel/uptime-kuma-api","owner":"wvogel","description":"Lightweight read-only REST API sidecar for Uptime Kuma — exposes monitor metadata and latest heartbeats to external dashboards","archived":false,"fork":false,"pushed_at":"2026-04-18T15:49:20.000Z","size":36,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-18T17:28:57.902Z","etag":null,"topics":["api","docker","fastapi","mariadb","monitoring","proxy","python","read-only","rest-api","self-hosted","sidecar","uptime-kuma"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wvogel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-06T06:52:54.000Z","updated_at":"2026-04-18T15:49:18.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/wvogel/uptime-kuma-api","commit_stats":null,"previous_names":["wvogel/kuma-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wvogel/uptime-kuma-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wvogel%2Fuptime-kuma-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wvogel%2Fuptime-kuma-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wvogel%2Fuptime-kuma-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wvogel%2Fuptime-kuma-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wvogel","download_url":"https://codeload.github.com/wvogel/uptime-kuma-api/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wvogel%2Fuptime-kuma-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33673657,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-29T02:00:06.066Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","docker","fastapi","mariadb","monitoring","proxy","python","read-only","rest-api","self-hosted","sidecar","uptime-kuma"],"created_at":"2026-05-29T23:04:15.644Z","updated_at":"2026-05-29T23:04:16.140Z","avatar_url":"https://github.com/wvogel.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# uptime-kuma-api\n\nLightweight read-only API proxy for [Uptime Kuma](https://github.com/louislam/uptime-kuma) monitor data. Designed to be deployed as a sidecar container alongside each Uptime Kuma instance. Part of [uptime-kuma-status](https://github.com/wvogel/uptime-kuma-status).\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n[![Python](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/)\n[![FastAPI](https://img.shields.io/badge/FastAPI-0.115-009688.svg)](https://fastapi.tiangolo.com/)\n[![Docker](https://img.shields.io/badge/docker-ghcr.io-2496ED.svg?logo=docker\u0026logoColor=white)](https://github.com/wvogel/uptime-kuma-api/pkgs/container/uptime-kuma-api)\n[![Uptime Kuma](https://img.shields.io/badge/Uptime%20Kuma-compatible-5CDD8B.svg)](https://github.com/louislam/uptime-kuma)\n[![Changelog](https://img.shields.io/badge/changelog-keepachangelog-orange.svg)](CHANGELOG.md)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](CONTRIBUTING.md)\n\n## Architecture\n\n![Architecture](docs/architecture-en.svg)\n\n## Quick Start\n\nAdd to your Uptime Kuma `docker-compose.yml`:\n\n```yaml\n  uptime-kuma-api:\n    image: ghcr.io/wvogel/uptime-kuma-api:latest\n    restart: unless-stopped\n    environment:\n      DB_HOST: mariadb        # your MariaDB service name\n      DB_NAME: kuma           # database name\n      DB_USER: kuma           # database user\n      DB_PASS: \u003cpassword\u003e     # database password\n      API_KEY: \u003cyour-api-key\u003e # generated by uptime-status admin\n    healthcheck:\n      test: [\"CMD\", \"curl\", \"-f\", \"http://127.0.0.1:80/health\"]\n      interval: 30s\n      retries: 3\n      start_period: 10s\n      timeout: 5s\n    networks:\n      - default\n      - shared-npm\n```\n\n## Environment Variables\n\n| Variable | Default | Description |\n|----------|---------|-------------|\n| `DB_HOST` | `mariadb` | MariaDB hostname |\n| `DB_PORT` | `3306` | MariaDB port |\n| `DB_NAME` | `kuma` | Database name |\n| `DB_USER` | `kuma` | Database user |\n| `DB_PASS` | *required* | Database password |\n| `API_KEY` | *required* | API key for authentication |\n| `ALLOWED_RANGES` | *(empty)* | Comma-separated CIDR ranges for IP filtering (e.g. `10.0.0.0/8,172.16.0.0/12`) |\n\n## Endpoints\n\n| Endpoint | Auth | Description |\n|----------|------|-------------|\n| `GET /health` | No | Healthcheck, returns `{\"status\": \"ok\"}` |\n| `GET /api/monitors` | `X-API-Key` | Returns all monitors + latest heartbeats |\n\n## Security\n\n- API key validated via constant-time comparison (`hmac.compare_digest`)\n- Optional IP range filtering via `ALLOWED_RANGES` (CIDR notation)\n- `X-Forwarded-For` header respected for IP detection behind reverse proxies\n- Read-only database access\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwvogel%2Fuptime-kuma-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwvogel%2Fuptime-kuma-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwvogel%2Fuptime-kuma-api/lists"}