Get deployment status
GET
/
project
/
update-status
/
Get update status
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": {
"name": "<string>",
"avatarUrl": "<string>",
"githubUserId": 123
},
"commit": {
"sha": "<string>",
"ref": "<string>",
"message": "<string>",
"filesChanged": {
"added": [
"<string>"
],
"modified": [
"<string>"
],
"removed": [
"<string>"
]
}
},
"source": "internal"
}Authorizations
Section titled “Authorizations”Authorization
string
header
required
The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.
Path Parameters
Section titled “Path Parameters”statusId
string
required
The status ID of a triggered update.
Response
Section titled “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
object | null
The author of the update.
Show child attributes
commit
object
The commit details
Show child attributes
source
enum<string>
The source of the update trigger.
Available options:
internal,
github-app-installation,
api,
github,
dashboard,
gitlab,
onboarding
⌘I