Référence de l'API

Lire un déploiement

Lit un déploiement et son état.

GET/v13/deployments/:id

Requête

Paramètres de chemin

idstringrequis: Identifiant du déploiement.

En-têtes

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

curl https://api.host.hgdc.ch/v13/deployments/jd7f2k9m3x8q1p5s6t4v0w7y2z \
  -H "Authorization: Bearer $SMARTFLOW_HOST_TOKEN"

Réponse

200

{
  "id": "jd7f2k9m3x8q1p5s6t4v0w7y2z",
  "uid": "jd7f2k9m3x8q1p5s6t4v0w7y2z",
  "url": "site-atelier-h3k9x2.hgdc.cloud",
  "name": "site-atelier",
  "projectId": "j97d3k2m8x1q4p6s7t9v0w2y5z",
  "ownerId": "k57a1b2c3d4e5f6g7h8j9k0m1n",
  "readyState": "READY",
  "status": "READY",
  "target": "production",
  "type": "LAMBDAS",
  "createdAt": 1760259600000,
  "buildingAt": 1760259601000,
  "ready": 1760259604000,
  "alias": ["site-atelier-h3k9x2.hgdc.cloud"],
  "aliasAssigned": true,
  "aliasError": null,
  "errorMessage": null,
  "inspectorUrl": "https://host.hgdc.ch/atelier/site-atelier/deployments/jd7f2k9m3x8q1p5s6t4v0w7y2z",
  "meta": {
    "branch": "main",
    "commitSha": "4c3e2f1a9b8d7c6e5f4a3b2c1d0e9f8a7b6c5d4e",
    "commitMessage": "Nouvelle page Tarifs"
  },
  "creator": { "uid": "u1a2b3c4d5" }
}

Objet déploiement

idstring: Identifiant du déploiement. uid porte la même valeur.
urlstring: Adresse du déploiement, sans https://. Elle reste valable tant que le déploiement existe.
namestring: Nom du projet.
projectIdstring: Identifiant du projet.
ownerIdstring: Identifiant de l'équipe.
readyState"QUEUED" | "BUILDING" | "READY" | "ERROR" | "CANCELED": État du déploiement. status porte la même valeur.
target"production" | null: production, ou null pour une preview.
createdAtnumber: Date de création, en millisecondes. buildingAt donne le début du traitement, ready sa fin (null tant qu'il n'est pas prêt).
aliasstring[]: L'adresse du déploiement, une fois un déploiement de production prêt. Vide sinon.
aliasAssignedboolean: true quand le déploiement est prêt.
errorMessagestring | null: Cause de l'échec, quand readyState vaut ERROR.
inspectorUrlstring: Page du déploiement dans la console.
metaobject: Informations Git : branch, commitSha, commitMessage, quand elles sont connues.
creator.uidstring: Personne qui a créé la clé utilisée.
type"LAMBDAS": Valeur fixe, pour la CLI. aliasError vaut toujours null.

Attendre la fin

Pour attendre qu'un déploiement soit prêt, interrogez cet endpoint toutes les secondes jusqu'à READY, ERROR ou CANCELED. Ou ouvrez le flux de Suivre les logs, qui se ferme tout seul à la fin.

Erreurs

Statut	Code	Quand
404	`not_found`	Déploiement inconnu, d'une autre équipe 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.