Alle Umgebungsvariablen ersetzen

PUT

apps

{app_id}

envs

Alle Umgebungsvariablen ersetzen

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

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. Overwrite ersetzt die gesamte Umgebung der Anwendung durch genau die gesendeten Variablen: Alles, was bereits gesetzt ist und nicht im Request-Body enthalten ist, wird gelöscht. Ein leeres envs-Objekt löscht sämtliche Variablen, weshalb dieser Endpunkt für einen vollständigen Reset gedacht ist, nicht für inkrementelle Änderungen. Es gelten dieselben Limits wie bei den anderen Endpunkten für Umgebungsvariablen: bis zu 256 Variablen pro Anwendung, 1024 Zeichen pro Schlüssel, 4096 pro Wert. Statische Anwendungen werden nicht unterstützt und liefern einen Fehler, und 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. Da die gesamte Menge gesendet wird, sorgt eine Variable, die schon unter einem ungültigen Namen gespeichert ist (mit Leerzeichen oder einer Ziffer am Anfang), dafür, dass die Anfrage mit INVALID_ENV_CONTENT antwortet: Benenne sie in der Anfrage um. Wenn du nur wenige Variablen ändern möchtest, ohne den Rest anzufassen, nutze stattdessen Variablen hinzufügen/bearbeiten, oder Variablen entfernen, um bestimmte Schlüssel zu löschen.

Parameter

string

erforderlich

Die Anwendungs-ID.

object

Der Schlüssel und Wert der Variablen, die du in der Umgebung haben möchtest.

Antwort

string

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

object

Der Schlüssel und Wert aller von dir definierten Umgebungsvariablen.

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

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

Alle Umgebungsvariablen ersetzen

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

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Alle Umgebungsvariablen ersetzen

Parameter

Antwort

Häufige Fehler

Siehe auch

​Parameter

​Antwort

​Häufige Fehler

​Siehe auch

Parameter

Antwort

Häufige Fehler

Siehe auch