跳转到内容

自动化 API

MyPanel 提供一套主要用于驱动界面的 REST API。本页列出适用于自动化场景的稳定接口(CI/CD、运维脚本)。请使用 API 令牌Pro)进行身份验证。

每个请求都需要包含以下请求头:

Authorization: Bearer mpat_xxxxxxxx

基础 URL 即你的面板地址,例如 https://panel.example.com。下面的示例使用了两个变量:

Terminal window
PANEL=https://panel.example.com
TOKEN=mpat_xxxxxxxx
Terminal window
# 列出网站
curl -H "Authorization: Bearer $TOKEN" $PANEL/api/sites
# 创建网站 (reverseproxy / static / nixpacks / dockerfile / image / wordpress)
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"domain":"app.example.com","buildKind":"reverseproxy","source":"http://127.0.0.1:3000"}' \
$PANEL/api/sites
# 按 id 部署网站
curl -X POST -H "Authorization: Bearer $TOKEN" $PANEL/api/sites/1/deploy
# 获取最近一次部署的状态
curl -H "Authorization: Bearer $TOKEN" $PANEL/api/sites/1/deployment
# 删除网站
curl -X DELETE -H "Authorization: Bearer $TOKEN" $PANEL/api/sites/1
Terminal window
# 列出数据库
curl -H "Authorization: Bearer $TOKEN" $PANEL/api/databases
# 创建数据库
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
-d '{"engine":"MySQL","name":"app_prod"}' $PANEL/api/databases
# 按 id 触发数据库备份
curl -X POST -H "Authorization: Bearer $TOKEN" $PANEL/api/databases/1/backups
Terminal window
# 服务器信息(主机名、操作系统、运行时长、负载、版本)
curl -H "Authorization: Bearer $TOKEN" $PANEL/api/system
# 更新状态(当前版本 / 最新版本)
curl -H "Authorization: Bearer $TOKEN" $PANEL/api/update
状态码含义
200 / 201 / 202 / 204成功
400请求体无效
401缺少或无效的令牌
402已达套餐上限(返回中包含 {"upgrade":"pro"}
403权限不足
404未找到资源