Aller au contenu

Tape un mot pour chercher dans les pages.

↑↓ Choisir↵ OuvrirÉchap Fermer

Référence

Renvoie les variables d'un environnement au format de vercel pull, avec les règles de visibilité des variables sensibles.

Cet endpoint renvoie les variables d’un environnement, au format attendu par vercel pull et vercel build. Les valeurs sont renvoyées déchiffrées : elles ne doivent jamais partir vers le navigateur.

GET /v3/env/pull/:project/:target

curl https://api.host.hgdc.ch/v3/env/pull/site-atelier/production \
-H "Authorization: Bearer $VERCEL_TOKEN"
# Équivalent avec la CLI
vercel --api https://api.host.hgdc.ch pull --environment=production

Paramètres de chemin

ParamètreTypeRequisDescription
projectstringOuiIdentifiant ou nom du projet
target"production", "preview" ou "development"NonEnvironnement. Par défaut : development

Réponse

Réponse 200 :

{
"env": {
"PUBLIC_API_URL": "https://api.atelier.ch",
"CONTACT_EMAIL": "bonjour@atelier.ch"
},
"buildEnv": {
"PUBLIC_API_URL": "https://api.atelier.ch",
"CONTACT_EMAIL": "bonjour@atelier.ch"
}
}

env et buildEnv contiennent les mêmes variables. Si le projet a un domaine de production, VERCEL_PROJECT_PRODUCTION_URL figure aussi dans la réponse. Voir Variables : référence.

La réponse n’est jamais mise en cache : elle porte cache-control: no-store.

Variables sensibles

Une variable sensible n’est renvoyée qu’à une clé limitée au projet, celle que l’app GitHub pose dans le dépôt. Avec une clé d’organisation, elle est absente de la réponse.

Chaque lecture d’une variable par une clé est consignée dans le journal du coffre, sans la valeur. Voir Secrets et coffre.

Erreurs

StatutCodeCause
400bad_requestEnvironnement inconnu
404not_foundProjet inconnu, ou hors de la portée de la clé

Voir la liste complète sur Erreurs.