Lister les déploiements avec l'API Vercel
Liste 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.
- Identifiant
- vercel_list_deployments
L'appel
POST https://connect.reportei.com/api/tools/vercel_list_deployments/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"teamId": "<teamId>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| teamId | string | Non | With a Full Account token, the id of a team from List teams, to act on that team. Omit it for the personal account or with a team token. |
| projectId | string | Non | Only deployments of this project: its id or name, from List projects. |
| target | string | Non | Only deployments of this environment, such as production or preview. |
| state | string | Non | Comma-separated states: BUILDING, ERROR, INITIALIZING, QUEUED, READY, CANCELED or BLOCKED. Example: BUILDING,READY. |
| branch | string | Non | Only deployments of this Git branch. |
| sha | string | Non | Only deployments of this Git commit. |
| limit | number | Non | Maximum number of deployments to return. |
| since | number | Non | Only deployments created after this time, in milliseconds since 1970. |
| until | number | Non | Only deployments created before this time, in milliseconds since 1970. For the next page, the pagination.next of the previous response. |
Connexions possibles
Votre client connecte son compte Vercel une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/vercel_list_deployments. Il devient la définition de tool de votre agent sans conversion.
Autres tools Vercel
- 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.
- 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é.
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.
