> ## Documentation Index
> Fetch the complete documentation index at: https://smartac-justin-client-exports.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

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

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="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="rate-limits">
  ## Limites de débit
</div>

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


## OpenAPI

````yaml fr/openapi.json POST /project/preview/{projectId}
openapi: 3.0.1
info:
  title: Mintlify External API
  description: Une API pour gérer la documentation Mintlify et accéder aux ressources.
  version: 1.0.0
servers:
  - url: https://api.mintlify.com/v1
security:
  - bearerAuth: []
paths:
  /project/preview/{projectId}:
    post:
      summary: Déclencher un déploiement de prévisualisation
      description: >-
        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.
      parameters:
        - name: projectId
          in: path
          description: >-
            Identifiant de votre projet. Vous pouvez le copier à partir de la
            page [API
            keys](https://dashboard.mintlify.com/settings/organization/api-keys)
            de votre Dashboard.
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - branch
              properties:
                branch:
                  type: string
                  description: >-
                    Le nom de la branche Git pour laquelle créer un déploiement
                    de prévisualisation.
                  minLength: 1
      responses:
        '202':
          description: Déploiement de prévisualisation mis en file d'attente avec succès.
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusId:
                    type: string
                    description: >-
                      L'identifiant de statut pour suivre le déploiement de
                      prévisualisation. Utilisez-le avec l'endpoint [Get
                      deployment status](/fr/api/update/status).
                  previewUrl:
                    type: string
                    description: >-
                      L'URL à laquelle le déploiement de prévisualisation est
                      hébergé.
        '400':
          description: Requête non valide. Le champ `branch` est obligatoire.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '403':
          description: >-
            Les déploiements de prévisualisation ne sont pas disponibles avec
            votre offre actuelle.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        L’en-tête Authorization requiert un jeton Bearer. Utilisez une clé d’API
        administrateur (préfixée par `mint_`). Il s’agit d’une clé secrète
        utilisée côté serveur. Générez-en une depuis la page [API
        keys](https://dashboard.mintlify.com/settings/organization/api-keys) de
        votre Dashboard.

````