跳转到主要内容
GET
/
project
/
update-status
/
{statusId}
获取更新状态
curl --request GET \
  --url https://api.mintlify.com/v1/project/update-status/{statusId} \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "projectId": "<string>",
  "createdAt": "<string>",
  "endedAt": "<string>",
  "status": "queued",
  "summary": "<string>",
  "logs": [
    "<string>"
  ],
  "subdomain": "<string>",
  "screenshot": "<string>",
  "screenshotLight": "<string>",
  "screenshotDark": "<string>",
  "author": "<string>",
  "commit": {
    "sha": "<string>",
    "ref": "<string>",
    "message": "<string>",
    "filesChanged": {
      "added": [
        "<string>"
      ],
      "modified": [
        "<string>"
      ],
      "removed": [
        "<string>"
      ]
    }
  },
  "source": "internal"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
statusId
string
required

已触发的更新的状态 ID。

Response

200 - application/json

成功响应

​
_id
string

已触发更新项的状态 ID。

​
projectId
string

文档项目的 ID。

​
createdAt
string

具有指定 UTC 日期时间的 ISODate

​
endedAt
string

包含指定 UTC 日期时间的 ISODate

​
status
enum<string>

更新状态。

可用选项:
queued,
in_progress,
success,
failure
​
summary
string

更新状态概览

​
logs
string[]

一组日志。

​
subdomain
string

正在更新的文档站点的子域。

​
screenshot
string

文档截图。

​
screenshotLight
string

文档截图。

​
screenshotDark
string

文档在深色模式下的截图。

​
author
string

此更新的作者。

​
commit
object

提交详情

​
source
enum<string>

更新触发器的来源。

可用选项:
internal,
github-app-installation,
api,
github,
dashboard