添加或编辑环境变量
添加或更新应用的环境变量（POST /v2/apps/:app_id/envs）。请求体中未包含的变量保持不变，适合轮换单个密钥。
POST
/
v2
/
apps
/
{app_id}
/
envs
添加或编辑环境变量
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"
}
}
需要具有
envs:write 权限范围的 API 密钥。写入权限不包含读取权限：没有 envs:read 时，响应中绝不会包含请求未发送的变量。
使用该端点可以添加新的环境变量或更新特定的环境变量，而不影响其余变量。请求体中未包含的现有变量将保持不变，这使它成为轮换单个 API 密钥等增量更改的最安全选择。
静态应用不支持环境变量，会返回错误。每个应用的完整变量集上限为 256 个，键最长 1024 个字符，值最长 4096 个字符（为其添加的引号不计入）。在工作区共享的应用上，调用者需要具有 admin 角色或为所有者。
你的应用通过 shell 加载变量，因此包含空格或 shell 特殊字符（例如 & 或 ;）的值会像控制面板一样用单引号括起来存储，并按此形式返回；你已经加了引号的值会按发送时的样子保留。对其他变量的引用（$HOST、${HOST}，单独使用或放在双引号内）仍然有效，而命令替换（$(...) 或反引号）始终按纯文本存储。名称由字母、数字、下划线、点和连字符组成，且不能以数字开头。
如果要替换整个变量集而不是合并，请使用覆盖变量。要移除特定的键，请参阅移除变量；要读取当前的值，请参阅列出变量。
参数
string
必填
应用程序 ID。
object
必填
环境变量的键和值。
响应
string
指示调用是否成功。成功时为
success，否则为 error。object
更改后应用的所有环境变量。没有
envs:read 权限范围的 API 密钥只会收到本次请求中发送的变量。{
"status": "success",
"response": {
"TEST": "myTest"
}
}
常见错误
| 代码 | HTTP | 说明 |
|---|---|---|
STATIC_APP_ENV_NOT_SUPPORTED | 400 | 该应用为静态应用；静态应用不支持环境变量。 |
INVALID_ENV_CONTENT | 400 | envs 缺失、不是对象、是数组，或某个变量名无效。 |
TOO_MANY_ENV_VARS | 400 | 合并后的变量集将超过 256 个环境变量。 |
ENV_NAME_TOO_LONG | 400 | 某个变量键超过 1024 个字符。 |
ENV_CONTENT_TOO_LONG | 400 | 某个变量值超过 4096 个字符。 |
相关内容
- CLI：
squarecloud app env set - SDK：
api.apps.envs.set()（JavaScript）、client.apps.envs.set()（Python）、c.Apps.Envs.Set()（Go）
⌘I
添加或编辑环境变量
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"
}
}