触发预览部署

以编程方式为指定分支创建或重新构建预览部署。

POST /project/preview/{projectId}

触发预览部署

cURL

curl --request POST \
  --url https://api.mintlify.com/v1/project/preview/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "<string>"
}
'

202

{
  "statusId": "<string>",
  "previewUrl": "<string>"
}

授权

Authorization · string · header · 必填

Authorization 请求头需要使用 Bearer token。请使用以 mint_ 为前缀的管理员 API key。该 key 是仅供服务端使用的机密密钥。你可以在控制台的 API keys 页面 中生成一个。

路径参数

projectId · string · 必填

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

请求体

application/json

branch · string · 必填

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

Minimum string length: 1

响应

202

application/json

预览部署已成功加入队列

statusId · string

已触发的预览部署的状态 ID。使用此 ID 配合获取部署状态端点来轮询进度。

previewUrl · string

预览部署可访问的 URL。