Openship REST API 速查指南：Projects、Deployments、Domains、Tokens 四大核心端点全解析

Openship REST API 速查指南Projects、Deployments、Domains、Tokens 四大核心端点全解析【免费下载链接】openshipSelf-hosted deployment platform项目地址: https://gitcode.com/GitHub_Trending/ope/openshipOpenship 是一款开源的自托管部署平台self-hosted deployment platform能从 Git 仓库一键构建、部署应用并自动处理域名路由与 TLS 证书。本文是一份Openship REST API 速查面向新手与集成开发者汇总 Projects项目、Deployments部署、Domains域名、Tokens令牌四大核心端点帮你快速上手用 API 驱动整套部署流程 认证方式用 Bearer Token 访问 API所有/api/*端点都要求认证。推荐流程先在 Web 控制台的 Settings 里创建一个PAT个人访问令牌然后在每个请求中携带请求头Authorization: Bearer 你的令牌令牌的解析逻辑见 bearer.ts它是所有 Bearer 认证的唯一入口 提示为 CI/CD 流水线单独创建一个作用域受限的 PAT用完即撤销比共用账号密码安全得多。Projects 项目端点创建、更新与查询项目路由挂载在/api/projects见 project.routes.ts是 Openship REST API 中使用频率最高的一组端点。方法路径用途GET/api/projects列出组织内所有项目POST/api/projects从 Git 仓库或本地源创建项目GET/api/projects/:id获取项目详情配置、源、路由、状态PATCH/api/projects/:id更新项目构建配置DELETE/api/projects/:id删除项目建议先看删除预览GET/api/projects/:id/deletion-preview只读预览删除会移除哪些资源GET/api/projects/:id/environments列出环境production / 预览POST/api/projects/:id/environments创建预览环境GET/api/projects/:id/env查看环境变量密钥值自动掩码PATCH/api/projects/:id/env合并式修改环境变量未提及的变量保持不变POST/api/projects/:id/enable启用项目允许部署POST/api/projects/:id/disable停用项目暂停部署GET/api/projects/:id/deployments列出该项目部署历史GET/api/projects/:id/pending-actions查看阻塞项及每项的具体解决方式GET/api/projects/:id/logs获取运行时日志非流式POST/api/projects/:id/routing/retry重试免费域名的边缘路由同步 新手最常踩的坑改环境变量请用PATCH 合并upserts deletes不要尝试全量覆盖避免误清空密钥类变量。路由定义可参考 project.routes.ts。Deployments 部署端点触发构建、回滚与取消部署路由挂载在/api/deployments见 deployment.routes.ts覆盖触发 → 跟踪 → 决策 → 回滚的完整生命周期。方法路径用途GET/api/deployments列出组织内部署可用?projectId过滤POST/api/deployments从已关联的 Git 源触发部署推送即部署POST/api/deployments/build/access向导式部署入口支持文件夹上传流程GET/api/deployments/:id查看部署状态、URL、耗时与错误摘要GET/api/deployments/:id/build实时构建进度当前步骤、各服务状态GET/api/deployments/:id/logs获取构建 / 运行日志GET/api/deployments/:id/pending部署卡住时查看等待项及解锁调用POST/api/deployments/:id/build/respond回答阻塞决策如端口冲突释放端口或中止POST/api/deployments/:id/redeploy重跑该项目最近一次部署POST/api/deployments/:id/rollback回滚到指定部署的产物 / 提交POST/api/deployments/:id/cancel取消进行中的部署POST/api/deployments/:id/restart重启该部署正在运行的容器DELETE/api/deployments/:id删除部署记录 排障心法当部署看起来卡住了先轮询GET /:id/pending——它会直接告诉你阻塞原因例如端口已被占用以及具体该调用哪个端点来解除。更多操作端点可参考 deployment.routes.ts。Domains 域名端点DNS 验证与 SSL 续期域名路由挂载在/api/domains见 domain.routes.ts支持免费子域与自定义域名的验证、DNS 自动配置和证书续期。方法路径用途GET/api/domains列出组织 / 项目的域名POST/api/domains添加域名免费子域或自定义域名POST/api/domains/preview添加前预览该域名所需的 DNS 记录GET/api/domains/:id查看单个域名的验证与 SSL 状态POST/api/domains/:id/verify验证域名所有权 / DNSPOST/api/domains/:id/primary将该域名设为主域名GET/api/domains/:id/records获取需要配置的 DNS 记录GET/api/domains/:id/dns/plan只读预览通过已连接供应商自动配置会改什么POST/api/domains/:id/dns/apply通过已连接 DNS 供应商自动写入记录POST/api/domains/:id/renew续期该域名的 SSL 证书POST/api/domains/:id/verify-ssl检查并验证 SSL 证书POST/api/domains/renew-all批量续期全部证书DELETE/api/domains/:id删除域名 推荐顺序preview预览 DNS → 添加 →verify验证 →renew等证书签发。dns/plan与dns/apply是先预览后落盘的两步式设计永远不会静默修改你的 DNS。Tokens 令牌端点PAT 管理与 MCP 授权令牌路由挂载在/api/tokens见 token.routes.ts每个操作都只作用于当前调用者自己的令牌天然隔离。方法路径用途GET/api/tokens列出我的 PATPOST/api/tokens创建 PAT可指定作用域如项目级读写DELETE/api/tokens/:id撤销吊销PATPOST/api/tokens/mcp-authorize授权一个 MCP 客户端GET/api/tokens/mcp-clients列出已连接的 MCP 客户端DELETE/api/tokens/mcp-clients/:clientId断开 MCP 客户端 安全建议给每个自动化场景CI、脚本、MCP 工具发一个独立令牌并设定最小作用域出问题时精准吊销即可不影响其他集成。端点细节见 token.routes.ts。一条链完成部署REST API 常见工作流把上面四组端点串起来就是一个完整的 API 驱动部署流水线 创建/确认项目POST /api/projectsGit 源→GET /api/projects/:id拿到id触发部署POST /api/deployments或/api/deployments/build/access返回deployment_id跟踪进度轮询GET /api/deployments/:id/build卡住就看GET /:id/pending并按resolveWith提示作答接上域名POST /api/domains→POST /:id/verify→ 等待证书就绪兜底操作出问题POST /:id/rollback秒级回滚或POST /:id/cancel取消构建一个最小的调用示例其余请求同理仅需替换方法与路径curl -H Authorization: Bearer 你的令牌 \ https://你的Openship地址/api/projects掌握这份 Openship REST API 速查后你就可以把自建部署平台完全纳入脚本、CI 与自动化体系让推送代码 → 上线只需一条 API 调用 ⚡【免费下载链接】openshipSelf-hosted deployment platform项目地址: https://gitcode.com/GitHub_Trending/ope/openship创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考