radiantone/uptime-kuma-api

Uptime-Kuma-Web-API

镜像概述

本镜像为https://github.com/louislam/uptime-kuma%E7%9B%91%E6%8E%A7%E5%B7%A5%E5%85%B7%E6%8F%90%E4%BE%9BREST API封装，基于https://github.com/lucasheld/uptime-kuma-api%E5%BA%93%E5%BC%80%E5%8F%91%EF%BC%8C%E6%97%A8%E5%9C%A8%E9%80%9A%E8%BF%87API%E6%96%B9%E5%BC%8F%E6%89%A9%E5%B1%95Uptime Kuma的管理能力。

核心功能

• 多用户支持（暂未实现权限管理），内置SQLite数据库存储用户信息
• 提供覆盖Uptime Kuma大部分功能的REST API
• 集成Swagger文档，便于API调试与使用
• 支持多架构（amd64、arm64）
• 完全Docker化，部署简单

使用场景

• 自动化监控配置与管理
• 将Uptime Kuma集成到现有运维系统或自定义平台
• 批量操作监控项（如添加、修改、删除监控）
• 通过API获取监控状态与告警信息

配置说明

环境变量

必填变量

需定义以下变量以连接Uptime Kuma实例：

• KUMA_SERVER：Uptime Kuma实例的URL，例如https://uptime.example.com
• KUMA_USERNAME：Uptime Kuma的用户名
• KUMA_PASSWORD：Uptime Kuma的密码
• ADMIN_PASSWORD：API的管理员密码（必须设置，否则无法访问API）

可选变量

• ACCESS_TOKEN_EXPIRATION：访问令牌有效期（分钟），默认8天
• SECRET_KEY：用于JWT编码的密钥

注意事项

• API登录凭据为：用户名admin，密码为设置的ADMIN_PASSWORD
• 需先启动Uptime Kuma实例并创建用户，再部署本API镜像

部署示例

Docker Compose配置

yaml
version: "3.9"
services:
  kuma:
    container_name: uptime-kuma
    image: louislam/uptime-kuma:latest
    ports:
      - "3001:3001"
    restart: always
    volumes:
      - uptime-kuma:/app/data

  api:
    container_name: backend
    image: medaziz11/uptimekuma_restapi
    volumes:
      - api:/db
    restart: always
    environment:
      - KUMA_SERVER=http://kuma:3001
      - KUMA_USERNAME=test
      - KUMA_PASSWORD=123test.
      - ADMIN_PASSWORD=admin
    depends_on:
      - kuma
    ports:
      - "8000:8000"

volumes:
  uptime-kuma:
  api:

CURL使用示例

获取访问令牌并调用API：

bash
TOKEN=$(curl -X POST -H 'Content-Type: application/x-www-form-urlencoded' --data 'username=admin&password=admin' [***] | jq -r ".access_token")
curl -H 'Accept: application/json' -H "Authorization: Bearer ${TOKEN}" [***]