Annuler un déploiement avec l'API Netlify
Arrête un déploiement encore en file d'attente ou en cours de build et le renvoie.
- Identifiant
- netlify_cancel_deploy
L'appel
POST https://connect.reportei.com/api/tools/netlify_cancel_deploy/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"deploy_id": "<deploy_id>"
}
}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 |
|---|---|---|---|
| deploy_id | string | Oui | The id of the deploy, from List site deploys. |
Connexions possibles
Votre client connecte son compte Netlify 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/netlify_cancel_deploy. Il devient la définition de tool de votre agent sans conversion.
Autres tools Netlify
- Lister les sitesGETListe les sites (projets, dans l'interface Netlify) accessibles au compte, avec id, nom, url, custom_domain, le déploiement publié et les réglages de build. L'id ou le domaine d'un site est le site_id que prennent les autres outils. Paginez avec page et per_page : une page avec moins d'éléments que per_page est la dernière.
- Mettre à jour un sitePATCHModifie le nom ou les domaines d'un site et le renvoie. Seuls les champs envoyés changent. Le DNS d'un nouveau domaine personnalisé doit encore pointer vers Netlify.
- Lister les déploiements du siteGETListe les déploiements d'un site, du plus récent au plus ancien, avec id, state, branch, context, error_message et l'URL du déploiement. Paginez avec page et per_page : une page avec moins d'éléments que per_page est la dernière.
- Obtenir un déploiementGETRenvoie un déploiement, avec state (ready quand il est en ligne ou prêt à publier, error quand le build a échoué), error_message, branch, commit_ref, published_at et l'URL du déploiement.
- Créer un build du sitePOSTLance un build d'un site depuis son dépôt connecté et renvoie le build, avec deploy_id à suivre dans Obtenir un déploiement. Sans branch, il construit la production ; une autre branche produit un déploiement de branche. Il attend en file quand l'équipe n'a pas de capacité de build libre.
- Restaurer un déploiement du sitePOSTPublie à nouveau un déploiement antérieur et en fait la version en ligne du site, ce qui constitue un rollback. Renvoie le déploiement.
- Lister les formulaires du siteGETListe les formulaires que Netlify a détectés dans un site, avec id, nom, champs et submission_count. Les soumissions elles-mêmes viennent de Lister les soumissions d'un formulaire.
- Lister les soumissions du siteGETListe les soumissions de tous les formulaires d'un site, de la plus récente à la plus ancienne, avec nom, email, les données de chaque champ et created_at. Paginez avec page et per_page : une page avec moins d'éléments que per_page est la dernière.
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.
