Déclencher un déploiement de prévisualisation

Créez ou reconstruisez un déploiement de prévisualisation pour une branche spécifique de manière programmatique.

POST /project/preview/{projectId}

Déclencher un déploiement de prévisualisation

cURL

curl --request POST \
  --url https://api.mintlify.com/v1/project/preview/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "branch": "<string>"
}
'

202

{
  "statusId": "<string>",
  "previewUrl": "<string>"
}

Autorisations

Authorization · string · header · requis

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 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 pour laquelle créer un déploiement de prévisualisation.

Minimum string length: 1

Réponse

202

application/json

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

statusId · string

L'identifiant de statut du déploiement de prévisualisation déclenché. Utilisez-le avec l'endpoint Obtenir le statut du déploiement pour suivre la progression.

previewUrl · string

L'URL à laquelle le déploiement de prévisualisation sera accessible.