Add trigger preview deployment API endpoint#5467
Merged
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
cdxker
approved these changes
Apr 21, 2026
dino475
approved these changes
Apr 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
POST /project/preview/{projectId}API endpoint that lets users programmatically create or update preview deployments for a specific Git branchShipped in mintlify/server#4633: a new public API endpoint that mirrors the existing update trigger pattern, enabling customers to create preview deployments via the REST API using their admin API key.
Note
Low Risk
Low risk: documentation and OpenAPI-spec updates only, with no runtime/business-logic changes in this repo.
Overview
Adds a new documented admin REST endpoint,
POST /project/preview/{projectId}, to programmatically create or redeploy branch preview deployments (returnsstatusId+previewUrl, with400/403cases).Wires the new endpoint into the docs site by adding
api/preview/trigger.mdx, linking it from the API introduction and preview-deployments guide, and exposing it indocs.jsonnavigation.Reviewed by Cursor Bugbot for commit cea95da. Bugbot is set up for automated code reviews on this repo. Configure here.