Get update status

Get the status of an update from the status ID

GET /project/update-status/{statusId}

Try it

Get update status

cURL

curl --request GET \
  --url https://api.mintlify.com/v1/project/update-status/{statusId} \
  --header 'Authorization: Bearer <token>'

200

{
  "_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

The status ID of a triggered update.

Response

200 - application/json

A successful response

_id · string

The status ID of the triggered updated.

projectId · string

The documentation project ID.

createdAt · string

An ISODate with the specified datetime in UTC

endedAt · string

An ISODate with the specified datetime in UTC

status · enum<string>

The status of the update.

Available options: queued, in_progress, success, failure

summary · string

Summary of the status of the update

logs · string[]

An array of logs.

subdomain · string

The subdomain of the docs being updated.

screenshot · string

A screenshot of the docs.

screenshotLight · string

A screenshot of the docs.

screenshotDark · string

A screenshot of the docs in dark mode.

author · string

The author of the update.

commit · object

The commit details

Show child attributes

commit. sha · string

The SHA of the commit.

commit. ref · string

The ref of the commit.

commit. message · string

The commit message.

commit. filesChanged · object

Details on the changed files.

Show child attributes

commit.filesChanged. added · string[]

New files added.

commit.filesChanged. modified · string[]

Existing files that were modified.

commit.filesChanged. removed · string[]

Files that were removed.

source · enum<string>

The source of the update trigger.

Available options: internal, github-app-installation, api, github, dashboard