mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
564f4a768a
* configure assistant on starter plan * assistant * update workflows changelog note * auth * Update custom-frontend.mdx * remove pro plan
21 lines
914 B
Plaintext
21 lines
914 B
Plaintext
---
|
|
title: "Trigger preview deployment"
|
|
openapi: "/openapi.json POST /project/preview/{projectId}"
|
|
keywords: ["preview", "preview deployment", "branch preview", "staging"]
|
|
|
|
---
|
|
|
|
Use this endpoint to programmatically create or update a preview deployment for a Git branch. If a preview already exists for the specified branch, the endpoint triggers a redeployment instead of creating a duplicate.
|
|
|
|
The response includes a `statusId` that you can pass to [Get deployment status](/api/update/status) to track the deployment progress.
|
|
|
|
## Use cases
|
|
|
|
- **CI/CD pipelines**: Automatically create preview deployments when users open or update pull requests.
|
|
- **Scheduled previews**: Build previews from long-running feature branches on a schedule.
|
|
- **Custom tooling**: Integrate preview creation into internal workflows or Slack bots.
|
|
|
|
## Rate limits
|
|
|
|
This endpoint allows up to 5 requests per minute per organization.
|