curl -X GET https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1 \
-H "Authorization: Bearer mint_your_api_key_here"
const response = await fetch(
'https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1',
{
method: 'GET',
headers: {
'Authorization': 'Bearer mint_your_api_key_here',
},
}
);
const data = await response.json();
console.log(data.status);
import requests
response = requests.get(
'https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1',
headers={
'Authorization': 'Bearer mint_your_api_key_here'
}
)
data = response.json()
print(data['status'])
{
"_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"
}
Admin
Get Update Status
Get the status of an update from the status ID
GET
/
v1
/
project
/
update-status
/
{statusId}
curl -X GET https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1 \
-H "Authorization: Bearer mint_your_api_key_here"
const response = await fetch(
'https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1',
{
method: 'GET',
headers: {
'Authorization': 'Bearer mint_your_api_key_here',
},
}
);
const data = await response.json();
console.log(data.status);
import requests
response = requests.get(
'https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1',
headers={
'Authorization': 'Bearer mint_your_api_key_here'
}
)
data = response.json()
print(data['status'])
{
"_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 withmint_). Generate one on the API keys page in your dashboard.
Path Parameters
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. Possible values:
queued, in_progress, success, failure.string
Summary of the status of the update.
string
An ISO date with the specified datetime in UTC when the update was created.
string
An ISO date with the specified datetime in UTC when the update ended.
array
An array of logs from the update process.
string
The subdomain of the docs being updated.
string
A screenshot of the docs.
string
A screenshot of the docs in light mode.
string
A screenshot of the docs in dark mode.
string
The author of the update.
object
string
The source of the update trigger. Possible values:
internal, github-app-installation, api, github, dashboard.curl -X GET https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1 \
-H "Authorization: Bearer mint_your_api_key_here"
const response = await fetch(
'https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1',
{
method: 'GET',
headers: {
'Authorization': 'Bearer mint_your_api_key_here',
},
}
);
const data = await response.json();
console.log(data.status);
import requests
response = requests.get(
'https://api.mintlify.com/v1/project/update-status/6501a2b3c4d5e6f7g8h9i0j1',
headers={
'Authorization': 'Bearer mint_your_api_key_here'
}
)
data = response.json()
print(data['status'])
{
"_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"
}