SDK JavaScript : variables d'environnement

Les variables d’environnement se trouvent sur api.apps.envs. Chaque méthode prend d’abord l’identifiant de l’application et renvoie les variables de l’application sous forme d’un simple Record<string, string>. Les exemples utilisent le client api présenté dans Créer le client. appId est l’identifiant de l’une de vos applications : api.account.me() les liste.

Les applications statiques n’ont pas de variables d’environnement : chaque méthode répond 400 STATIC_APP_ENV_NOT_SUPPORTED. Une modification prend effet au prochain redémarrage.

Lire les variables

const envs = await api.apps.envs.get(appId);

console.log(envs.NODE_ENV);

Ajouter ou mettre à jour des variables

envs.set(appId, envs) ajoute les clés fournies et écrase celles qui existent déjà. Les autres variables sont conservées. La méthode renvoie toutes les variables après la modification.

const envs = await api.apps.envs.set(appId, {
    NODE_ENV: "production",
    LOG_LEVEL: "info",
});

Remplacer toutes les variables

envs.replace(appId, envs) remplace toutes les variables par l’ensemble fourni. Les clés absentes de l’objet sont supprimées.

await api.apps.envs.replace(appId, { NODE_ENV: "production" });

Supprimer des variables

envs.delete(appId, keys) supprime les clés fournies et renvoie les variables restantes.

const remaining = await api.apps.envs.delete(appId, ["LOG_LEVEL"]);

Limites et erreurs

Statut	Code	Quand
400	`STATIC_APP_ENV_NOT_SUPPORTED`	L’application est statique
400	`INVALID_ENV_CONTENT`	Les variables ne forment pas un objet valide (ou, pour `delete`, une liste vide)
400	`TOO_MANY_ENV_VARS`	Le résultat dépasserait 256 variables
400	`ENV_NAME_TOO_LONG`	Une clé dépasse 1024 caractères
400	`ENV_CONTENT_TOO_LONG`	Une valeur dépasse 4096 caractères
400	`READ_FAILED`	Le cluster n’a pas pu lire les variables

Prochaines étapes

Deploys

Déployez à chaque push, avec un webhook ou la GitHub App.

Référence de l'API des variables d'environnement

Les endpoints REST derrière ces méthodes.

Variables depuis la CLI

Les mêmes actions depuis le terminal.

Lire les variables dans votre code

Définissez les variables depuis le tableau de bord, la CLI ou l’API et lisez-les à l’exécution.

CLI

VS Code

SDKs

SDK JavaScript : variables d'environnement

Lire les variables

Ajouter ou mettre à jour des variables

Remplacer toutes les variables

Supprimer des variables

Limites et erreurs

Prochaines étapes

Deploys

Référence de l'API des variables d'environnement

Variables depuis la CLI

Lire les variables dans votre code

​Lire les variables

​Ajouter ou mettre à jour des variables

​Remplacer toutes les variables

​Supprimer des variables

​Limites et erreurs

​Prochaines étapes

Deploys

Référence de l'API des variables d'environnement

Variables depuis la CLI

Lire les variables dans votre code

Lire les variables

Ajouter ou mettre à jour des variables

Remplacer toutes les variables

Supprimer des variables

Limites et erreurs

Prochaines étapes