mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
f072caaf92
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
36 lines
2.3 KiB
Plaintext
36 lines
2.3 KiB
Plaintext
---
|
|
title: "Déclencher un déploiement de prévisualisation"
|
|
openapi: "/fr/openapi.json POST /project/preview/{projectId}"
|
|
keywords: ["preview", "preview deployment", "branch preview", "staging"]
|
|
---
|
|
|
|
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](/fr/api/update/status) pour suivre la progression du déploiement.
|
|
|
|
<div id="branch-requirements">
|
|
## Exigences relatives à la branche
|
|
</div>
|
|
|
|
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](/fr/deploy/preview-deployments#fork-pull-requests) pour savoir comment prévisualiser les modifications d'un fork.
|
|
|
|
<div id="use-cases">
|
|
## Cas d'utilisation
|
|
</div>
|
|
|
|
- **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.
|
|
|
|
<div id="access-to-previews">
|
|
## Accès aux prévisualisations
|
|
</div>
|
|
|
|
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](/fr/deploy/preview-deployments#restrict-access-to-preview-deployments).
|
|
|
|
<div id="rate-limits">
|
|
## Limites de débit
|
|
</div>
|
|
|
|
Cet endpoint autorise jusqu'à 5 requêtes par minute et par organisation.
|