curl -X POST https://api.mintlify.com/v1/project/update/your_project_id \
-H "Authorization: Bearer mint_your_api_key_here"
const response = await fetch(
'https://api.mintlify.com/v1/project/update/your_project_id',
{
method: 'POST',
headers: {
'Authorization': 'Bearer mint_your_api_key_here',
},
}
);
const data = await response.json();
console.log(data.statusId);
import requests
response = requests.post(
'https://api.mintlify.com/v1/project/update/your_project_id',
headers={
'Authorization': 'Bearer mint_your_api_key_here'
}
)
data = response.json()
print(data['statusId'])
{
"statusId": "6501a2b3c4d5e6f7g8h9i0j1"
}
Admin
Trigger Update
Queue a deployment update for your documentation project
POST
/
v1
/
project
/
update
/
{projectId}
curl -X POST https://api.mintlify.com/v1/project/update/your_project_id \
-H "Authorization: Bearer mint_your_api_key_here"
const response = await fetch(
'https://api.mintlify.com/v1/project/update/your_project_id',
{
method: 'POST',
headers: {
'Authorization': 'Bearer mint_your_api_key_here',
},
}
);
const data = await response.json();
console.log(data.statusId);
import requests
response = requests.post(
'https://api.mintlify.com/v1/project/update/your_project_id',
headers={
'Authorization': 'Bearer mint_your_api_key_here'
}
)
data = response.json()
print(data['statusId'])
{
"statusId": "6501a2b3c4d5e6f7g8h9i0j1"
}
Queue a deployment update for your documentation project. Returns a status ID that can be used to track the update progress. The update is triggered from your configured deployment branch.
Authentication
Requires an admin API key (prefixed withmint_). Generate one on the API keys page in your dashboard.
Path Parameters
Response
string
The status ID of the triggered update. Use this with the Get update status endpoint to track progress.
curl -X POST https://api.mintlify.com/v1/project/update/your_project_id \
-H "Authorization: Bearer mint_your_api_key_here"
const response = await fetch(
'https://api.mintlify.com/v1/project/update/your_project_id',
{
method: 'POST',
headers: {
'Authorization': 'Bearer mint_your_api_key_here',
},
}
);
const data = await response.json();
console.log(data.statusId);
import requests
response = requests.post(
'https://api.mintlify.com/v1/project/update/your_project_id',
headers={
'Authorization': 'Bearer mint_your_api_key_here'
}
)
data = response.json()
print(data['statusId'])
{
"statusId": "6501a2b3c4d5e6f7g8h9i0j1"
}
Common use cases
- CI/CD integration: Trigger documentation updates automatically when code changes are pushed to your repository
- Scheduled updates: Set up cron jobs to refresh documentation at regular intervals
- Webhook integration: Update docs in response to external events or API calls
- Multi-environment deployments: Programmatically manage deployments across different environments