Skip to main content
POST
Déclencher un déploiement de prévisualisation
Utilisez cet endpoint pour créer ou mettre à jour de manière programmatique un déploiement de prévisualisation pour une branche Git. Si une prévisualisation existe déjà pour la branche spécifiée, l’endpoint déclenche un redéploiement au lieu de créer un doublon. La réponse inclut un statusId que vous pouvez transmettre à Get deployment status pour suivre la progression du déploiement.

Exigences relatives à la branche

La 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

Les prévisualisations créées avec cet endpoint sont accessibles publiquement, sauf si vous activez l’authentification pour vos prévisualisations, qui s’applique alors à chaque prévisualisation de votre déploiement. Vous ne pouvez pas protéger par mot de passe une prévisualisation individuelle via cet endpoint. Consultez Restreindre l’accès aux déploiements de prévisualisation.

Limites de débit

Cet endpoint autorise jusqu’à 5 requêtes par minute et par organisation.

Autorisations

Authorization
string
header
requis

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

projectId
string
requis

Identifiant de votre projet. Vous pouvez le copier à partir de la page API keys de votre Dashboard.

Corps

application/json
branch
string
requis

Le nom de la branche Git pour laquelle créer un déploiement de prévisualisation.

Minimum string length: 1

Réponse

Déploiement de prévisualisation mis en file d'attente avec succès.

statusId
string

L'identifiant de statut pour suivre le déploiement de prévisualisation. Utilisez-le avec l'endpoint Get deployment status.

previewUrl
string

L'URL à laquelle le déploiement de prévisualisation est hébergé.