Référence de l'API

Suivre les logs d'un déploiement

Renvoie les logs de traitement, en direct avec follow=1.

GET/v3/deployments/:id/events

La réponse est au format NDJSON : une ligne JSON par événement. Avec follow=1, la connexion reste ouverte et reçoit les nouvelles lignes au fil de l'eau.

Requête

Paramètres de chemin

idstringrequis: Identifiant du déploiement.

Paramètres de requête

follow"1": Garde la connexion ouverte jusqu'à la fin du déploiement, 9 minutes au plus.

En-têtes

Authorizationstringrequis: Bearer ah_…, votre clé d'API.

curl -N "https://api.host.hgdc.ch/v3/deployments/jd7f2k9m3x8q1p5s6t4v0w7y2z/events?follow=1" \
  -H "Authorization: Bearer $SMARTFLOW_HOST_TOKEN"

Réponse

Type application/x-ndjson. Chaque ligne de log ressemble à ceci :

Événement de log

{"type":"stdout","created":1760259601000,"date":1760259601000,"deploymentId":"jd7f2k9m3x8q1p5s6t4v0w7y2z","id":"l3k…","text":"Publication de 42 fichiers","payload":{"id":"l3k…","text":"Publication de 42 fichiers","date":1760259601000,"deploymentId":"jd7f2k9m3x8q1p5s6t4v0w7y2z"}}

Champs d'un événement

type"stdout" | "stderr": stderr pour une ligne d'erreur.
textstring: Texte de la ligne.
datenumber: Date de la ligne, en millisecondes. created porte la même valeur.
payloadobject: Les mêmes champs, au format historique de la CLI.

Une fois le déploiement terminé, une dernière ligne donne son état, puis le flux se ferme :

Événement final

{"type":"state","event":"state","date":1760259604000,"payload":{"value":"READY"}}

Le même endpoint répond aussi sous /v3/now/deployments/:id/events.

Erreurs

Statut	Code	Quand
404	`not_found`	Déploiement inconnu ou hors de la portée de la clé.

Toutes les routes peuvent aussi répondre 403 forbidden, 429 rate_limited et 500 internal_server_error. Voir Erreurs.