API — 许可证、访问与证书
通过 API 查询许可证状态、管理身份验证、读取整体系统状态,并下载根证书。
许可证
GET
/api/v1/license/status
需要鉴权
返回许可证是否处于激活状态,以及您的套餐和端口上限。
示例 (curl)
curl -H "X-API-Key: YOUR_API_KEY" http://127.0.0.1:8891/api/v1/license/status
身份验证
POST
/api/v1/auth/login
无需鉴权
使用控制面板密码登录并设置会话 Cookie。
请求体
{ "password": "your-dashboard-password" }
POST
/api/v1/auth/logout
需要鉴权
清除会话 Cookie。
GET
/api/v1/auth/status
需要鉴权
报告当前的登录状态和密码状态。
POST
/api/v1/auth/password
需要鉴权
更改控制面板密码(需要提供当前密码)。
请求体
{ "current": "old-password", "new": "new-password" }
POST
/api/v1/auth/apikey/rotate
需要鉴权
生成一个新的 API 密钥并返回。旧密钥将立即失效。
响应
{ "api_key": "a1b2c3d4..." }
系统状态
GET
/api/v1/status
需要鉴权
返回整体状态:版本、已开启端口数与端口上限、身份数量、运行时长等信息。
示例 (curl)
curl -H "X-API-Key: YOUR_API_KEY" http://127.0.0.1:8891/api/v1/status
GET
/api/v1/health
无需鉴权
一个始终返回 OK 的简单健康检查。
根证书 (CA)
GET
/api/v1/ca
需要鉴权
以 PEM 文本格式下载根证书。
GET
/api/v1/ca.crt
需要鉴权
以 DER 格式下载证书(适用于 macOS/iOS 上的原生安装)。
GET
/api/v1/ca.mobileconfig
需要鉴权
下载可安装该证书的 Apple .mobileconfig 描述文件。