Skip to content

Add trigger preview deployment API endpoint#5467

Merged
dino475 merged 1 commit intomainfrom
mintlify/preview-api-1776736147
Apr 21, 2026
Merged

Add trigger preview deployment API endpoint#5467
dino475 merged 1 commit intomainfrom
mintlify/preview-api-1776736147

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 21, 2026

Summary

  • Adds documentation for the new POST /project/preview/{projectId} API endpoint that lets users programmatically create or update preview deployments for a specific Git branch
  • Adds the endpoint to the OpenAPI spec, API introduction page, navigation, and cross-references it from the preview deployments guide

Shipped 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 (returns statusId + previewUrl, with 400/403 cases).

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 in docs.json navigation.

Reviewed by Cursor Bugbot for commit cea95da. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 21, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 21, 2026, 1:54 AM

@dino475 dino475 merged commit ed3e461 into main Apr 21, 2026
5 checks passed
@dino475 dino475 deleted the mintlify/preview-api-1776736147 branch April 21, 2026 04:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants