Remplacer toutes les variables d'environnement

PUT

apps

{app_id}

envs

Remplacer toutes les variables d'environnement

curl --request PUT \
  --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.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  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 => "PUT",
  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("PUT", 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.put("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::Put.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": "overwriteTest"
  }
}

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. Overwrite remplace la totalité de l’environnement de l’application par exactement les variables que vous envoyez : tout ce qui est déjà défini et qui ne figure pas dans le corps de la requête est supprimé. Envoyer un objet envs vide efface toutes les variables, ce qui en fait l’endpoint à utiliser pour une réinitialisation complète plutôt qu’une modification incrémentale. Les mêmes limites que les autres endpoints de variables d’environnement s’appliquent : jusqu’à 256 variables par application, 1024 caractères par clé, 4096 par valeur. Les applications statiques ne sont pas prises en charge et renvoient une erreur, et 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. Comme l’ensemble complet est envoyé, une variable déjà stockée sous un nom invalide (avec un espace, ou commençant par un chiffre) fait répondre la requête INVALID_ENV_CONTENT : renommez-la dans la requête. Si vous avez seulement besoin de modifier quelques variables sans toucher aux autres, utilisez plutôt Ajouter/Modifier des variables, ou Supprimer des variables pour supprimer des clés spécifiques.

Paramètres

string

requis

L’ID de l’application.

object

La clé et la valeur des variables que vous souhaitez dans l’environnement.

Réponse

string

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

object

La clé et la valeur de toutes les variables d’environnement que vous avez définies.

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

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	Le nouvel ensemble 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 replace
SDK : api.apps.envs.replace() (JavaScript), client.apps.envs.replace() (Python), c.Apps.Envs.Replace() (Go)

Remplacer toutes les variables d'environnement

curl --request PUT \
  --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.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  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 => "PUT",
  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("PUT", 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.put("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::Put.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": "overwriteTest"
  }
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Remplacer toutes les 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