Trigger preview deployment
Create or update a preview deployment for a specific branch. If a preview already exists for the branch, it triggers a redeployment. Returns a status ID to track progress and the preview URL.
Authenticate with an admin API key.
statusId that you can pass to Get deployment status to track the deployment progress.
Branch requirements
Thebranch must exist in the repository connected to your Mintlify project and you must have the Mintlify GitHub App installed. Branches on forks are not supported. See Fork pull requests for how to preview changes from a fork.
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.
Access to previews
Previews created with this endpoint are publicly accessible unless you enable authentication for your previews, which applies to every preview in your deployment. You cannot password-protect an individual preview through this endpoint. See Restrict access to preview deployments.Rate limits
This endpoint allows up to 5 requests per minute per organization.Authorizations
The Authorization header expects a Bearer token. Use an admin API key. This is a server-side secret key. Generate one on the API keys page in your dashboard.
Path Parameters
Body
The name of the Git branch to create a preview deployment for.
1Response
Preview deployment queued successfully.
The status ID for tracking the preview deployment. Use this with the Get deployment status endpoint.
The URL where the preview deployment is hosted.