Aggiungi o modifica variabili d'ambiente

POST

apps

{app_id}

envs

Aggiungi o modifica variabili d'ambiente

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

obbligatorio

La chiave API del tuo account. Puoi trovarla nelle impostazioni del tuo account.

Richiede una chiave API con lo scope envs:write. La scrittura non dà accesso alla lettura: senza envs:read, la risposta non include mai variabili che la richiesta non ha inviato. Usa questo endpoint per aggiungere nuove variabili d’ambiente o aggiornarne alcune specifiche senza toccare le altre. Le variabili esistenti che non sono incluse nel corpo della richiesta restano invariate, il che lo rende l’opzione più sicura per modifiche incrementali come la rotazione di una singola chiave API. Le applicazioni statiche non supportano le variabili d’ambiente e restituiscono un errore. L’insieme completo è limitato a 256 variabili per applicazione, con un limite di 1024 caratteri per chiave e 4096 caratteri per valore (le virgolette aggiunte intorno non contano). Sulle applicazioni condivise in un workspace, chi effettua la richiesta deve avere il ruolo admin o essere il proprietario. La tua applicazione carica le variabili con una shell, quindi un valore con spazi o caratteri della shell (come & o ;) viene salvato tra virgolette singole, come fa la dashboard, e restituito così; un valore che hai già messo tra virgolette viene mantenuto come inviato. Un riferimento a un’altra variabile ($HOST, ${HOST}, da solo o tra virgolette doppie) continua a funzionare, mentre la sostituzione di comando ($(...) o backtick) viene sempre salvata come testo semplice. I nomi sono composti da lettere, cifre, underscore, punti e trattini, e non iniziano con una cifra. Per sostituire l’intero insieme di variabili invece di unirlo, usa Sovrascrivi Variabili. Per rimuovere chiavi specifiche, consulta Rimuovere Variabili, e per leggere i valori attuali, consulta Elenca Variabili.

Parametri

string

obbligatorio

L’ID dell’applicazione.

object

obbligatorio

La chiave e il valore delle variabili d’ambiente.

Risposta

string

Indica se la chiamata è andata a buon fine: success in caso affermativo, error in caso contrario.

object

Tutte le variabili d’ambiente dell’applicazione dopo la modifica. Una chiave API senza lo scope envs:read riceve solo le variabili che ha inviato in questa richiesta.

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

Errori comuni

Codice	HTTP	Significato
`STATIC_APP_ENV_NOT_SUPPORTED`	400	L’applicazione è statica; le applicazioni statiche non supportano le variabili d’ambiente.
`INVALID_ENV_CONTENT`	400	`envs` è mancante, non è un oggetto, o è un array, oppure un nome di variabile non è valido.
`TOO_MANY_ENV_VARS`	400	L’insieme risultante supererebbe le 256 variabili d’ambiente.
`ENV_NAME_TOO_LONG`	400	Una chiave di variabile supera i 1024 caratteri.
`ENV_CONTENT_TOO_LONG`	400	Un valore di variabile supera i 4096 caratteri.

Vedi anche

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

Aggiungi o modifica variabili d'ambiente

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"
  }
}

Primi passi

Account

Applicazioni

Database

Workspace

IA

Aggiungi o modifica variabili d'ambiente

Parametri

Risposta

Errori comuni

Vedi anche

​Parametri

​Risposta

​Errori comuni

​Vedi anche

Parametri

Risposta

Errori comuni

Vedi anche