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"
}Get the status of an update from the status ID
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"
}The Authorization header expects a Bearer token. Use an admin API key (prefixed with mint_). This is a server-side secret key. Generate one on the API keys page in your dashboard.
The status ID of a triggered update.
A successful response
The status ID of the triggered updated.
The documentation project ID.
An ISODate with the specified datetime in UTC
An ISODate with the specified datetime in UTC
The status of the update.
queued, in_progress, success, failure Summary of the status of the update
An array of logs.
The subdomain of the docs being updated.
A screenshot of the docs.
A screenshot of the docs.
A screenshot of the docs in dark mode.
The author of the update.
The commit details
Show child attributes
The source of the update trigger.
internal, github-app-installation, api, github, dashboard Was this page helpful?