Skip to main content
curl -X GET https://api.mintlify.com/v1/project/update-status/{statusId} \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Endpoint

​
statusId
string
required
The status ID of a triggered update. Returned from the Trigger update endpoint.

​
Response

​
_id
string
The status ID of the triggered update.
​
projectId
string
The documentation project ID.
​
status
string
The status of the update. One of: queued, in_progress, success, failure.
​
summary
string
Summary of the status of the update.
​
createdAt
string
An ISO 8601 datetime string with the specified datetime in UTC.
​
endedAt
string
An ISO 8601 datetime string with the specified datetime in UTC.
​
logs
array
An array of log messages from the update process.
​
subdomain
string
The subdomain of the docs being updated.
​
screenshot
string
A screenshot URL of the docs.
​
screenshotLight
string
A screenshot URL of the docs in light mode.
​
screenshotDark
string
A screenshot URL of the docs in dark mode.
​
author
string
The author of the update.
​
commit
object
The commit details
​
source
string
The source of the update trigger. One of: internal, github-app-installation, api, github, dashboard.
{
  "_id": "67890abcdef1234567890abc",
  "projectId": "12345abc",
  "status": "success",
  "summary": "Successfully deployed documentation",
  "createdAt": "2024-01-15T10:30:00.000Z",
  "endedAt": "2024-01-15T10:32:45.000Z",
  "logs": [
    "Starting build...",
    "Building pages...",
    "Deployment successful"
  ],
  "subdomain": "example",
  "author": "[email protected]",
  "commit": {
    "sha": "abc123def456",
    "ref": "main",
    "message": "Update documentation",
    "filesChanged": {
      "added": ["new-page.mdx"],
      "modified": ["introduction.mdx"],
      "removed": []
    }
  },
  "source": "api"
}

​
Authentication

This endpoint requires an admin API key (prefixed with mint_). Generate one on the API keys page in your dashboard.

Build docs developers (and LLMs) love

Get started for freeTalk to us