Get update status

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

const response = await fetch(
  `https://api.mintlify.com/v1/project/update-status/${statusId}`,
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const status = await response.json();
console.log('Update status:', status.status);

import requests

response = requests.get(
    f"https://api.mintlify.com/v1/project/update-status/{status_id}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY"
    }
)

status = response.json()
print(f"Update status: {status['status']}")

{
  "_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": "john@example.com",
  "commit": {
    "sha": "abc123def456",
    "ref": "main",
    "message": "Update documentation",
    "filesChanged": {
      "added": ["new-page.mdx"],
      "modified": ["introduction.mdx"],
      "removed": []
    }
  },
  "source": "api"
}

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

const response = await fetch(
  `https://api.mintlify.com/v1/project/update-status/${statusId}`,
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY'
    }
  }
);

const status = await response.json();
console.log('Update status:', status.status);

import requests

response = requests.get(
    f"https://api.mintlify.com/v1/project/update-status/{status_id}",
    headers={
        "Authorization": "Bearer YOUR_API_KEY"
    }
)

status = response.json()
print(f"Update status: {status['status']}")

Endpoint

string

required

The status ID of a triggered update. Returned from the Trigger update endpoint.

Response

string

The status ID of the triggered update.

string

The documentation project ID.

string

The status of the update. One of: queued, in_progress, success, failure.

string

Summary of the status of the update.

string

An ISO 8601 datetime string with the specified datetime in UTC.

string

An ISO 8601 datetime string with the specified datetime in UTC.

array

An array of log messages from the update process.

string

The subdomain of the docs being updated.

string

A screenshot URL of the docs.

string

A screenshot URL of the docs in light mode.

string

A screenshot URL of the docs in dark mode.

string

The author of the update.

object

The commit details

Show properties

string

The SHA of the commit.

string

The ref of the commit.

string

The commit message.

object

Details on the changed files.

Show properties

array

New files added.

array

Existing files that were modified.

array

Files that were removed.

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": "john@example.com",
  "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.

⌘I

Overview

Admin

Agent

Assistant

Analytics

Get update status

Endpoint

Response

Authentication

​Endpoint

​Response

​Authentication

Endpoint

Response

Authentication