Skip to main content
POST
触发预览部署
使用此端点以编程方式为 Git 分支创建或更新预览部署。如果指定分支已存在预览,该端点将触发重新部署,而不会创建重复项。 响应中包含一个 statusId,你可以将其传递给 Get deployment status 以跟踪部署进度。

分支要求

branch 必须存在于与你的 Mintlify 项目连接的仓库中。不支持 fork 上的分支。Mintlify GitHub 应用必须安装在仓库上才能构建预览,因此无法从 fork 分支构建预览。有关如何预览来自 fork 的更改,请参阅Fork 拉取请求

用例

  • CI/CD 流水线:在拉取请求被打开或更新时自动创建预览部署。
  • 定时预览:按计划为长期运行的功能分支生成预览。
  • 自定义工具:将预览创建集成到内部工作流或 Slack 机器人中。

预览的访问权限

通过此端点创建的预览可公开访问,除非你为预览启用了身份验证,该设置会应用于你部署中的所有预览。你无法通过此端点为单个预览设置密码保护。请参阅限制预览部署的访问权限

速率限制

此端点允许每个组织每分钟最多 5 个请求。

授权

Authorization
string
header
必填

Authorization 请求头需要使用 Bearer 令牌。请使用管理员 API 密钥。这是仅供服务端使用的机密密钥。你可以在控制台的 API 密钥页面 中生成一个。

路径参数

projectId
string
必填

项目 ID。可在控制台的 API keys 页面中复制。

请求体

application/json
branch
string
必填

要为其创建预览部署的 Git 分支名称。

Minimum string length: 1

响应

预览部署已成功加入队列。

statusId
string

用于跟踪预览部署的状态 ID。可将其与 Get deployment status 端点配合使用。

previewUrl
string

预览部署所托管的 URL。