medaziz11/uptimekuma_restapi Docker 镜像 - 轩辕镜像 | Docker 镜像高效稳定拉取服务

Uptime Kuma Web API Docker镜像文档

镜像概述

Uptime Kuma Web API Docker镜像是基于Uptime Kuma监控工具的Web API服务封装，旨在提供便捷的API接口，实现与Uptime Kuma服务的交互。通过该镜像，用户可轻松集成Uptime Kuma的监控能力到第三方系统或自动化流程中。

核心功能与特性

• Web API接口：提供标准化的RESTful API接口，支持与Uptime Kuma服务的双向数据交互
• 监控数据访问：可获取监控项状态、历史数据、告警信息等核心监控数据
• 监控项管理：支持通过API创建、修改、删除监控项及相关配置
• 轻量部署：基于Docker容器化设计，部署简单，环境依赖低

使用场景与适用范围

• 第三方系统集成：将Uptime Kuma监控数据集成到自定义仪表盘、工单系统等
• 自动化运维：通过API实现监控项的批量配置、状态巡检等自动化操作
• 数据备份与迁移：导出或导入监控配置数据，支持跨环境迁移
• 扩展开发：作为基础服务，用于开发基于Uptime Kuma的定制化监控工具

使用方法与配置说明

基本部署（Docker Run）

bash
docker run -d \
  --name uptime-kuma-api \
  -p 3001:3001 \  # 默认API端口，可根据需求修改
  -e UPTIME_KUMA_URL=[***] \  # Uptime Kuma主服务地址
  -e API_KEY=your_secure_api_key \  # API访问密钥（建议设置高强度密钥）
  medaziz11/uptime-kuma-web-api:latest

Docker Compose配置示例

yaml
version: '3'
services:
  uptime-kuma-api:
    image: medaziz11/uptime-kuma-web-api:latest
    container_name: uptime-kuma-api
    ports:
      - "3001:3001"
    environment:
      - UPTIME_KUMA_URL=[***]  # 需与Uptime Kuma服务网络互通
      - API_KEY=your_secure_api_key
      - LOG_LEVEL=info  # 日志级别：debug/info/warn/error
    restart: unless-stopped

环境变量配置

注意事项

• 确保UPTIME_KUMA_URL指向的Uptime Kuma服务已正常运行且网络可达
• API_KEY建议设置高强度随机字符串，避免未授权访问
• 详细API文档及接口定义请参考项目GitHub仓库：Uptime-Kuma-Web-API