Passer au contenu principal
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 et l’application GitHub Mintlify doit être installée. Cet endpoint ne prend pas en charge les 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 utilisateurs ouvrent ou mettent à jour des pull requests.
  • 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

Par défaut, les prévisualisations créées avec cet endpoint sont accessibles publiquement, sauf si vous activez l’authentification pour vos prévisualisations. Consultez Restreindre l’accès aux déploiements de prévisualisation. Pour restreindre l’accès à une prévisualisation spécifique, transmettez un objet auth dans le corps de la requête. Mintlify applique le paramètre d’accès à la prévisualisation avant de mettre le déploiement en file d’attente. Si vous omettez auth, la prévisualisation conserve ses paramètres d’accès actuels.
  • { "type": "password", "password": "..." } : Toute personne disposant du mot de passe peut consulter la prévisualisation. Les mots de passe doivent comporter au moins 8 caractères. La définition d’un mot de passe remplace tout mot de passe existant sur la prévisualisation.
  • { "type": "mintlify" } : Seuls les membres de votre organisation connectés à Mintlify peuvent consulter la prévisualisation.
La définition de auth est soumise aux exigences suivantes :
  • Votre offre doit inclure l’authentification des déploiements de prévisualisation. Sinon, l’endpoint renvoie une erreur 403.
  • Votre site doit avoir l’authentification ou l’authentification des prévisualisations activée. Sinon, l’endpoint renvoie une erreur 409.
  • L’authentification doit être activée sur la prévisualisation elle-même. Sinon, l’endpoint renvoie une erreur 409.

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
auth
Mot de passe · object

Restriction d'accès à appliquer à la prévisualisation. Omettez-la pour conserver les paramètres d'accès actuels de la prévisualisation. Nécessite une offre incluant l'authentification des prévisualisations, et votre site doit avoir l'authentification ou l'authentification des prévisualisations activée.

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é.