Ajouter ou modifier des variables d'environnement

POST

apps

{app_id}

envs

Ajouter ou modifier des variables d'environnement

curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/envs \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "envs": {}
}'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/envs"

payload = { "envs": {} }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({envs: {}})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/envs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/envs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'envs' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/envs"

	payload := strings.NewReader("{\n  \"envs\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/apps/{app_id}/envs")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"envs\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/envs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"envs\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "TEST": "myTest"
  }
}

string

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope envs:write. Écrire ne donne pas accès à la lecture : sans envs:read, la réponse n’inclut jamais les variables que la requête n’a pas envoyées. Utilisez cet endpoint pour ajouter de nouvelles variables d’environnement ou en mettre à jour certaines sans toucher aux autres. Les variables existantes qui ne figurent pas dans le corps de la requête restent inchangées, ce qui en fait l’option la plus sûre pour des modifications incrémentales comme la rotation d’une seule clé d’API. Les applications statiques ne prennent pas en charge les variables d’environnement et renvoient une erreur. L’ensemble complet est plafonné à 256 variables par application, avec une limite de 1024 caractères par clé et 4096 caractères par valeur (les guillemets ajoutés autour ne comptent pas). Sur les applications partagées en workspace, l’appelant doit avoir le rôle admin ou en être propriétaire. Votre application charge ses variables avec un shell : une valeur contenant des espaces ou des caractères de shell (comme & ou ;) est donc stockée entre guillemets simples, comme le fait le tableau de bord, et renvoyée ainsi ; une valeur que vous avez déjà mise entre guillemets est conservée telle qu’envoyée. Une référence à une autre variable ($HOST, ${HOST}, seule ou entre guillemets doubles) continue de fonctionner, tandis que la substitution de commande ($(...) ou accents graves) est toujours stockée en texte brut. Les noms sont composés de lettres, de chiffres, de tirets bas, de points et de tirets, sans commencer par un chiffre. Pour remplacer l’ensemble des variables plutôt que de fusionner, utilisez Écraser les variables. Pour supprimer des clés spécifiques, consultez Supprimer des variables, et pour lire les valeurs actuelles, consultez Lister les variables.

Paramètres

string

requis

L’ID de l’application.

object

requis

La clé et la valeur des variables d’environnement.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

object

Toutes les variables d’environnement de l’application après la modification. Une clé API sans le scope envs:read ne reçoit en retour que les variables qu’elle a envoyées dans cette requête.

{
  "status": "success",
  "response": {
    "TEST": "myTest"
  }
}

Erreurs courantes

Code	HTTP	Signification
`STATIC_APP_ENV_NOT_SUPPORTED`	400	L’application est statique ; les applications statiques ne prennent pas en charge les variables d’environnement.
`INVALID_ENV_CONTENT`	400	`envs` est manquant, n’est pas un objet, ou est un tableau, ou un nom de variable n’est pas valide.
`TOO_MANY_ENV_VARS`	400	L’ensemble fusionné dépasserait 256 variables d’environnement.
`ENV_NAME_TOO_LONG`	400	Une clé de variable dépasse 1024 caractères.
`ENV_CONTENT_TOO_LONG`	400	Une valeur de variable dépasse 4096 caractères.

Voir aussi

CLI : squarecloud app env set
SDK : api.apps.envs.set() (JavaScript), client.apps.envs.set() (Python), c.Apps.Envs.Set() (Go)

Ajouter ou modifier des variables d'environnement

curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/envs \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "envs": {}
}'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/envs"

payload = { "envs": {} }
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({envs: {}})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/envs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/envs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'envs' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/envs"

	payload := strings.NewReader("{\n  \"envs\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/apps/{app_id}/envs")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"envs\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/envs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"envs\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "response": {
    "TEST": "myTest"
  }
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Ajouter ou modifier des variables d'environnement

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi