Référence de l'API

Lire un projet

Lit un projet par son identifiant ou son nom.

GET/v9/projects/:idOrName

Requête

Paramètres de chemin

idOrNamestringrequis
Identifiant du projet, ou son nom (sans tenir compte de la casse).

En-têtes

Authorizationstringrequis
Bearer ah_…, votre clé d'API.
curl https://api.host.hgdc.ch/v9/projects/site-atelier \
  -H "Authorization: Bearer $SMARTFLOW_HOST_TOKEN"

Réponse

200
{
  "id": "j97d3k2m8x1q4p6s7t9v0w2y5z",
  "name": "site-atelier",
  "accountId": "k57a1b2c3d4e5f6g7h8j9k0m1n",
  "framework": "astro",
  "rootDirectory": null,
  "buildCommand": null,
  "installCommand": null,
  "outputDirectory": null,
  "nodeVersion": "24.x",
  "createdAt": 1760259600000,
  "updatedAt": 1760259600000,
  "link": {
    "type": "github",
    "repo": "atelier/site",
    "productionBranch": "main"
  }
}

Objet projet

idstring
Identifiant du projet. C'est la valeur de VERCEL_PROJECT_ID.
namestring
Nom du projet dans l'URL de la console, en minuscules.
accountIdstring
Identifiant de l'équipe propriétaire.
frameworkstring | null
Framework enregistré : nextjs, astro, vite, sveltekit, nuxt, tanstack-start, react-router, ou null pour un site sans framework.
rootDirectorystring | null
Dossier de l'app dans le dépôt, pour un monorepo.
buildCommandstring | null
Commande de build imposée. null : celle détectée par vercel build.
installCommandstring | null
Commande d'installation imposée.
outputDirectorystring | null
Dossier de sortie imposé.
nodeVersion"22.x" | "24.x"
Version de Node.js du build.
createdAtnumber
Date de création, en millisecondes depuis l'époque Unix. updatedAt porte la même valeur.
linkobject
Présent seulement pour un projet relié à GitHub : type (github), repo (propriétaire/dépôt) et productionBranch.

Erreurs

StatutCodeQuand
404not_foundAucun projet de ce nom dans l'équipe, ou projet 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.