---
title: "Get update status"
method: GET
path: "/project/update-status/{statusId}"
---

# Get update status

`GET /project/update-status/{statusId}`

Get the status of an update from the status ID

Authenticate with an admin API key.

## Path parameters

- `statusId` string, required

## Response `200`

A successful response

- object
  - `_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` 'queued' | 'in_progress' | 'success' | 'failure' — The status of the update.
  - `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, nullable — The author of the update.
    - `name` string — The name of the author.
    - `avatarUrl` string — URL of the author's avatar image.
    - `githubUserId` number — The author's GitHub user ID.
  - `commit` object — The commit details
    - `sha` string — The SHA of the commit.
    - `ref` string — The ref of the commit.
    - `message` string — The commit message.
    - `filesChanged` object — Details on the changed files.
      - `added` string[] — New files added.
      - `modified` string[] — Existing files that were modified.
      - `removed` string[] — Files that were removed.
  - `source` 'internal' | 'github-app-installation' | 'api' | 'github' | 'dashboard' | 'gitlab' | 'onboarding' — The source of the update trigger.

---

[API](https://skmtc.dev/mcp-b/apis/mintlify-admin-api.md) · [All operations](https://skmtc.dev/mcp-b/apis/mintlify-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/mcp-b/mintlify-admin-api/revisions/6165028f8792/schema)