文档 · 开放接口
用你自己的程序指挥 PocketBay
在控制台生成访问令牌后,就能用接口管理应用、触发部署、查询用量——为脚本、定时任务和 AI 助手而设。
三步上手
第一步:登录 PocketBay,点左下角头像,在菜单里进入「API 令牌」页创建一枚令牌。令牌只在创建时完整显示一次,请立即复制保存。第二步:调用接口时在请求头带上令牌:Authorization: Bearer 你的令牌。第三步:调用下方任一接口。想先用程序看看全部开放接口:
curl https://pocketbay.com/api/meta/capabilities
调用示例:
curl -H "Authorization: Bearer pb_xxx" https://pocketbay.com/api/projects
查应用、版本与回滚
- 应用列表:GET /api/projects
- 单个应用详情:GET /api/projects/{id}
- 版本历史:GET /api/projects/{id}/versions
- 部署历史:GET /api/projects/{id}/deployments
- 回滚到满足条件的历史版本:POST /api/projects/{id}/versions/{release_id}/rollback
示例:
curl -H "Authorization: Bearer pb_xxx" https://pocketbay.com/api/projects/123/deployments
部署与更新
- 上传源码并发起部署:POST /api/projects/{id}/deploy(表单上传,file 为 zip 源码包,version/message 可选)
- 用平台已存的源码重新部署:POST /api/projects/{id}/redeploy
- 查询进行中的部署:GET /api/projects/{id}/deploy/status
- 停止应用:POST /api/projects/{id}/stop
- 唤醒/启动应用:POST /api/projects/{id}/wake
上传部署示例:
curl -H "Authorization: Bearer pb_xxx" -F "file=@app.zip" https://pocketbay.com/api/projects/123/deploy
关于唤醒,两种官方方式:① 账号级(上面这条接口):适合你自己电脑上的脚本。② 应用专属钥匙:在应用的高级设置 →「程序化唤醒」里生成,只绑这一个应用、不需要账号登录,适合放进服务器和定时任务。休眠中的应用,浏览器访问会自动唤醒;程序请求(脚本、定时任务、第三方回调)只会收到空 204(带 X-Pocketbay-App-Status: sleeping 响应头),不会触发唤醒。正确姿势是先唤醒、轮询到 running 再访问:
curl -X POST -H "Authorization: Bearer pbw_你的钥匙" https://应用域名/.pocketbay/api/wake curl -H "Authorization: Bearer pbw_你的钥匙" https://应用域名/.pocketbay/api/status
应用设置、删除与域名
- 修改应用设置(名称、环境变量等):PATCH /api/projects/{id}
- 删除应用(不可恢复,请谨慎):DELETE /api/projects/{id}
- 查看/新增自定义域名:GET、POST /api/projects/{id}/domains
- 移除域名:DELETE /api/projects/{id}/domains/{domain_id}
- 设为主域:POST /api/projects/{id}/domains/{domain_id}/primary
- 检查域名 DNS 配置:GET /api/projects/{id}/domains/{domain_id}/check-dns
数据库与数据导出
托管数据库:
- 开通:POST /api/projects/{id}/database/provision
- 重置密码:POST /api/projects/{id}/database/reset-password
- 数据表清单:GET /api/projects/{id}/database/tables
- 执行查询:POST /api/projects/{id}/database/query
- 备份列表:GET /api/projects/{id}/database/backups
导出自己的数据分两步(导出票 5 分钟有效,数据盘与数据库每天各限 3 次):
curl -X POST -H "Authorization: Bearer pb_xxx" -H "Content-Type: application/json" -d '{"kind":"volume"}' https://pocketbay.com/api/projects/123/export-tickets
curl -o data.tar.gz "https://pocketbay.com/api/projects/123/volume/export?ticket=返回的票"(数据库导出把 kind 换成 database,下载地址换成 /database/export)
查用量与积分
- 用量汇总:GET /api/usage
- 资源指标与流量:GET /api/observability/overview 与 GET /api/observability/projects/{id}
- Cloud 与 AI 积分余额:GET /api/billing/balances
- 消耗流水:GET /api/billing/ledger
- 当前订阅:GET /api/billing/subscription
更省事的调用方式
- 不想直接调接口:pocketbay 命令行、MCP Server 与 GitHub 仓库部署见「AI 接入」文档。
- 直接在 Bayo 对话里问:Bayo 可以代你查询应用状态、指标、日志和流量,写操作会先弹出确认卡,确认后才会执行。
安全与访问范围
- 令牌等同你的账号钥匙:不要写进公开代码库、前端页面或聊天记录;控制台可随时撤销令牌,也能看到每枚令牌的最后使用时间。
- 开放范围仅限你自己的资源:接口只能访问当前登录用户名下的应用与数据;管理类与平台内部接口不对外开放。
- 全新应用的第一次上传建议通过网页部署页或命令行完成;开放接口适用于已有应用的日常管理与自动化。