Déclencher un déploiement de prévisualisation
Créez ou mettez à jour un déploiement de prévisualisation pour une branche spécifique. Si une prévisualisation existe déjà pour la branche, un redéploiement est déclenché. Retourne un identifiant de statut pour suivre la progression et l’URL de la prévisualisation.
Authentifiez-vous avec une clé d’API administrateur.
statusId que vous pouvez transmettre à Get deployment status pour suivre la progression du déploiement.
Exigences relatives à la branche
branch doit exister dans le dépôt connecté à votre projet Mintlify. Les branches de forks ne sont pas prises en charge. L’application GitHub Mintlify doit être installée sur un dépôt pour générer une prévisualisation, elle ne peut donc pas générer de prévisualisations à partir de branches de forks. Consultez Pull requests de forks pour savoir comment prévisualiser les modifications d’un fork.
Cas d’utilisation
- Pipelines CI/CD : Créez automatiquement des déploiements de prévisualisation lorsque des pull requests sont ouvertes ou mises à jour.
- Prévisualisations planifiées : Générez des prévisualisations de branches de fonctionnalités de longue durée selon un calendrier.
- Outillage personnalisé : Intégrez la création de prévisualisations dans des workflows internes ou des bots Slack.
Accès aux prévisualisations
Limites de débit
Autorisations
L'en-tête Authorization requiert un jeton Bearer. Utilisez une clé d'API administrateur. Il s'agit d'une clé secrète côté serveur. Générez-en une depuis la page des clés d'API de votre Dashboard.
Paramètres de chemin
Corps
Le nom de la branche Git pour laquelle créer un déploiement de prévisualisation.
1Réponse
Déploiement de prévisualisation mis en file d'attente avec succès.
L'identifiant de statut pour suivre le déploiement de prévisualisation. Utilisez-le avec l'endpoint Get deployment status.
L'URL à laquelle le déploiement de prévisualisation est hébergé.
Sujets connexes
DéploiementsDéclencher un déploiementDéploiement de prévisualisation non créé pour une branche de fork