Tools Vercel
Les 13 opérations Vercel que votre produit exécute sur le compte de votre client via Connect. Elles utilisent toutes le même endpoint, POST /api/tools/{tool}/execute.
- Lister les équipesGETListe les équipes auxquelles appartient le compte. Chaque élément a id, le teamId utilisé par les autres tools, et slug. Seul un token Full Account a besoin de teamId : un token créé pour une équipe agit déjà sur cette équipe. Paginez en passant pagination.next de la réponse comme until.
- Lister les projetsGETListe les projets du compte ou d'une équipe, avec leurs paramètres, lien Git et derniers déploiements. Chaque élément a id et name, que les autres tools utilisent comme projet. Paginez en passant pagination.next de la réponse comme from.
- Créer un projetPOSTCrée un projet et le renvoie, avec son id. Avec gitRepository, chaque push dans le dépôt déploie automatiquement ; l'app Vercel du fournisseur Git doit avoir accès au dépôt. Les paramètres de build omis sont détectés par Vercel.
- Mettre à jour un projetPATCHModifie le nom ou les paramètres de build d'un projet et le renvoie. Seuls les champs envoyés changent. Les nouveaux paramètres s'appliquent dès le prochain déploiement.
- Lister les déploiementsGETListe les déploiements, du plus récent au plus ancien, avec state, target, url et métadonnées Git. Chaque élément a uid, l'id du déploiement. Paginez en passant pagination.next de la réponse comme until.
- Obtenir un déploiementGETRenvoie un déploiement par son id ou son url, avec readyState, target, alias, projectId et, pour un build en échec, errorCode et errorMessage.
- Créer un déploiementPOSTDémarre un déploiement et le renvoie, avec id, url et readyState. Envoyez deploymentId pour redéployer un déploiement existant, ou gitSource pour déployer une branche ou un commit du dépôt connecté. Sans target, c'est un preview ; production en fait le déploiement de production. Le build prend quelques minutes : suivez-le avec Get deployment.
- Annuler un déploiementPATCHArrête un déploiement encore en file d'attente ou en build et le renvoie avec readyState CANCELED.
- Promouvoir un déploiementPOSTFait pointer les domaines de production d'un projet vers un déploiement existant, sans le reconstruire, par exemple pour revenir à un ancien déploiement de production. Pour mettre un preview en production avec un nouveau build, utilisez Create deployment avec son deploymentId et target production. Répond 201 ou 202 quand c'est accepté.
- Lister les événements d'un déploiementGETRenvoie le log de build d'un déploiement sous forme de liste d'événements, chacun avec type (comme stdout, stderr ou command), created et le texte de la ligne. Utilisez-le pour voir pourquoi un build a échoué.
- Lister les domaines d'un projetGETListe les domaines d'un projet, avec verified, la redirection et la branche Git de chacun. Paginez en passant pagination.next de la réponse comme until.
- Ajouter un domaine au projetPOSTAjoute un domaine à un projet et le renvoie avec verified. Faites ensuite pointer le DNS du domaine vers Vercel, comme l'indique Get domain config. Avec verified false, le domaine est utilisé ailleurs : créez l'enregistrement TXT listé dans verification et vérifiez-le dans le tableau de bord Vercel. Un domaine déjà dans le projet répond 400.
- Obtenir la config d'un domaineGETIndique si le DNS d'un domaine pointe vers Vercel : misconfigured, configuredBy et les valeurs recommendedIPv4 et recommendedCNAME à définir chez le fournisseur DNS.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
