Get Update Status

Get the status of an update from the status ID

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

cURL

curl -X GET https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1 \
  -H "Authorization: Bearer mint_your_api_key_here"

200 Response

{
  "_id": "6501a2b3c4d5e6f7g8h9i0j1",
  "projectId": "your_project_id",
  "status": "success",
  "summary": "Build completed successfully",
  "createdAt": "2024-03-15T10:30:00.000Z",
  "endedAt": "2024-03-15T10:32:45.000Z",
  "logs": [
    "Starting build process...",
    "Installing dependencies...",
    "Building documentation...",
    "Deployment successful"
  ],
  "subdomain": "your-docs",
  "author": "github-user",
  "commit": {
    "sha": "abc123def456",
    "ref": "main",
    "message": "Update documentation",
    "filesChanged": {
      "added": ["new-page.mdx"],
      "modified": ["introduction.mdx"],
      "removed": []
    }
  },
  "source": "api"
}

Get the status of an update from the status ID returned by the Trigger update endpoint.

Authentication

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

Path Parameters

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. Possible values: queued, in_progress, success, failure.

summary · string

Summary of the status of the update.

createdAt · string

An ISO date with the specified datetime in UTC when the update was created.

endedAt · string

An ISO date with the specified datetime in UTC when the update ended.

logs · array

An array of logs from the update process.

subdomain · string

The subdomain of the docs being updated.

screenshot · string

A screenshot of the docs.

screenshotLight · string

A screenshot of the docs in light mode.

screenshotDark · string

A screenshot of the docs in dark mode.

author · string

The author of the update.

commit · object

The commit details.

Show properties

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.

Show properties

added · array

New files added.

modified · array

Existing files that were modified.

removed · array

Files that were removed.

source · string

The source of the update trigger. Possible values: internal, github-app-installation, api, github, dashboard.

cURL

curl -X GET https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1 \
  -H "Authorization: Bearer mint_your_api_key_here"

200 Response

{
  "_id": "6501a2b3c4d5e6f7g8h9i0j1",
  "projectId": "your_project_id",
  "status": "success",
  "summary": "Build completed successfully",
  "createdAt": "2024-03-15T10:30:00.000Z",
  "endedAt": "2024-03-15T10:32:45.000Z",
  "logs": [
    "Starting build process...",
    "Installing dependencies...",
    "Building documentation...",
    "Deployment successful"
  ],
  "subdomain": "your-docs",
  "author": "github-user",
  "commit": {
    "sha": "abc123def456",
    "ref": "main",
    "message": "Update documentation",
    "filesChanged": {
      "added": ["new-page.mdx"],
      "modified": ["introduction.mdx"],
      "removed": []
    }
  },
  "source": "api"
}