Umgebungsvariablen hinzufügen oder bearbeiten

POST

apps

{app_id}

envs

Umgebungsvariablen hinzufügen oder bearbeiten

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

erforderlich

Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.

Erfordert einen API-Schlüssel mit dem Scope envs:write. Schreiben gewährt keinen Lesezugriff: Ohne envs:read enthält die Antwort nie Variablen, die die Anfrage nicht gesendet hat. Nutze diesen Endpunkt, um neue Umgebungsvariablen hinzuzufügen oder bestimmte zu aktualisieren, ohne den Rest anzufassen. Vorhandene Variablen, die nicht im Request-Body enthalten sind, bleiben unverändert, was ihn zur sichersten Option für inkrementelle Änderungen macht, etwa das Rotieren eines einzelnen API-Keys. Statische Anwendungen unterstützen keine Umgebungsvariablen und liefern einen Fehler zurück. Die gesamte Menge ist auf 256 Variablen pro Anwendung begrenzt, mit einem Limit von 1024 Zeichen pro Schlüssel und 4096 Zeichen pro Wert (die darum ergänzten Anführungszeichen zählen nicht). Bei Workspace-geteilten Anwendungen benötigt der Aufrufer die Rolle admin oder muss Eigentümer sein. Deine Anwendung lädt ihre Variablen mit einer Shell, daher wird ein Wert mit Leerzeichen oder Shell-Zeichen (etwa & oder ;) in einfachen Anführungszeichen gespeichert, wie es das Dashboard tut, und so zurückgegeben; ein Wert, den du schon in Anführungszeichen gesetzt hast, bleibt wie gesendet. Ein Verweis auf eine andere Variable ($HOST, ${HOST}, allein oder in doppelten Anführungszeichen) funktioniert weiter, während eine Befehlssubstitution ($(...) oder Backticks) immer als reiner Text gespeichert wird. Namen bestehen aus Buchstaben, Ziffern, Unterstrichen, Punkten und Bindestrichen und beginnen nicht mit einer Ziffer. Um die gesamte Variablenmenge zu ersetzen statt sie zusammenzuführen, nutze Variablen überschreiben. Um bestimmte Schlüssel zu entfernen, siehe Variablen entfernen, und um die aktuellen Werte zu lesen, siehe Variablen auflisten.

Parameter

string

erforderlich

Die Anwendungs-ID.

object

erforderlich

Der Schlüssel und Wert der Umgebungsvariablen.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.

object

Alle Umgebungsvariablen der Anwendung nach der Änderung. Ein API-Schlüssel ohne den Scope envs:read erhält nur die Variablen zurück, die er in dieser Anfrage gesendet hat.

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

Häufige Fehler

Code	HTTP	Bedeutung
`STATIC_APP_ENV_NOT_SUPPORTED`	400	Die Anwendung ist statisch; statische Anwendungen unterstützen keine Umgebungsvariablen.
`INVALID_ENV_CONTENT`	400	`envs` fehlt, ist kein Objekt oder ist ein Array, oder ein Variablenname ist ungültig.
`TOO_MANY_ENV_VARS`	400	Die zusammengeführte Menge würde 256 Umgebungsvariablen überschreiten.
`ENV_NAME_TOO_LONG`	400	Ein Variablenschlüssel überschreitet 1024 Zeichen.
`ENV_CONTENT_TOO_LONG`	400	Ein Variablenwert überschreitet 4096 Zeichen.

Siehe auch

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

Umgebungsvariablen hinzufügen oder bearbeiten

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

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Umgebungsvariablen hinzufügen oder bearbeiten

Parameter

Antwort

Häufige Fehler

Siehe auch

​Parameter

​Antwort

​Häufige Fehler

​Siehe auch

Parameter

Antwort

Häufige Fehler

Siehe auch