跳转到内容

API 参考

LLStack 面板提供 REST API,所有端点以 /api 为前缀。

除登录和 Setup 端点外,所有 API 需要在 Header 中携带 JWT Token:

Authorization: Bearer <token>
// 成功
{"code": 0, "data": { ... }}
// 错误
{"code": 40001, "message": "error_key"}
含义
0成功
40001参数错误
40100未认证
40300权限不足
40400资源不存在
50000服务器错误
方法路径说明
POST/api/auth/login登录
POST/api/auth/logout登出
POST/api/auth/refresh刷新 Token
GET/api/auth/me获取当前用户
POST/api/auth/2fa/setup配置 2FA
POST/api/auth/2fa/verify验证 2FA
方法路径说明
GET/api/sites站点列表
POST/api/sites创建站点
GET/api/sites/{id}站点详情
PUT/api/sites/{id}更新站点
DELETE/api/sites/{id}删除站点
GET/api/sites/{id}/cache获取缓存配置
PUT/api/sites/{id}/cache更新缓存配置
POST/api/sites/{id}/cache/purge清除缓存
方法路径说明
GET/api/databases数据库列表
POST/api/databases创建数据库
DELETE/api/databases/{id}删除数据库
POST/api/databases/{id}/export导出
POST/api/databases/{id}/import导入
方法路径说明
GET/api/wordpress/instances实例列表
POST/api/wordpress/install-quick快速安装
POST/api/wordpress/scan扫描实例
POST/api/wordpress/instances/{id}/security-scan安全扫描
GET/api/wordpress/instances/{id}/plugins插件列表
POST/api/wordpress/instances/{id}/plugins/update-all批量更新
方法路径说明
POST/api/backup/restic/init初始化仓库
POST/api/backup/restic/snapshot创建快照
GET/api/backup/restic/snapshots快照列表
POST/api/backup/restic/restore恢复快照
POST/api/backup/restic/forget清理快照
GET/api/backup/restic/stats仓库统计
方法路径说明
GET/api/system/stats系统状态
POST/api/system/upgrade面板升级
POST/api/system/service-upgrade服务升级
GET/api/system/version-check检查更新
方法路径说明
GET/api/monitoring/history历史数据
GET/api/monitoring/redis-historyRedis 历史
GET/api/monitoring/cgroup-pressurecgroup 压力
方法路径说明
POST/api/sites/{id}/staging创建 Staging 环境
POST/api/sites/{id}/staging/pushPush 变更到正式站点
POST/api/sites/{id}/staging/pullPull 正式站点到 Staging
DELETE/api/sites/{id}/staging删除 Staging 环境
GET/api/sites/{id}/staging/status获取 Staging 状态
方法路径说明
GET/api/sites/{id}/cdn获取 CDN 配置
PUT/api/sites/{id}/cdn更新 CDN 配置
DELETE/api/sites/{id}/cdn移除 CDN 集成
POST/api/sites/{id}/cdn/purge清除 CDN 缓存

漏洞数据库 (/api/wordpress/vulnerability-db)

Section titled “漏洞数据库 (/api/wordpress/vulnerability-db)”
方法路径说明
POST/api/wordpress/instances/{id}/security-scanCVE 漏洞扫描
GET/api/wordpress/vulnerability-db/status数据库状态
POST/api/wordpress/vulnerability-db/sync同步漏洞数据
PUT/api/wordpress/vulnerability-db/token配置 API Token
DELETE/api/wordpress/vulnerability-db/token删除 API Token

自动更新 (/api/wordpress/instances/{id}/auto-update)

Section titled “自动更新 (/api/wordpress/instances/{id}/auto-update)”
方法路径说明
GET/api/wordpress/instances/{id}/auto-update获取自动更新配置
PUT/api/wordpress/instances/{id}/auto-update更新自动更新配置

备份调度 (/api/backup/restic/schedule)

Section titled “备份调度 (/api/backup/restic/schedule)”
方法路径说明
GET/api/backup/restic/schedule获取调度配置
PUT/api/backup/restic/schedule更新调度配置

选择性恢复 (/api/backup/restic/restore)

Section titled “选择性恢复 (/api/backup/restic/restore)”
方法路径说明
POST/api/backup/restic/restore选择性恢复(支持 mode 参数:all/files/database)
方法路径说明
GET/api/redis/{id}/aclACL 用户列表
POST/api/redis/{id}/acl创建 ACL 用户
DELETE/api/redis/{id}/acl/{username}删除 ACL 用户

用户权限 (/api/users/{id}/permissions)

Section titled “用户权限 (/api/users/{id}/permissions)”
方法路径说明
GET/api/users/{id}/permissions获取用户权限
PUT/api/users/{id}/permissions更新用户权限