アプリケーション - 環境変数
変数の上書き
環境変数を新しい値で上書きします。
PUT
/
v2
/
apps
/
{app_id}
/
envs
変数の上書き
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"
}
}
上書きは、送信した変数だけでアプリケーションの環境全体を置き換えます。リクエストボディに含まれていない既存の変数はすべて削除されます。空の
envs オブジェクトを送信するとすべての変数が消去されるため、差分更新ではなく完全なリセットを行いたい場合に使用するエンドポイントです。
他の環境変数エンドポイントと同じ制限が適用されます。変数はアプリケーションごとに最大 256 個、キーは 1024 文字まで、値は 4096 文字までです。静的アプリケーションには対応しておらずエラーが返され、ワークスペースで共有されているアプリケーションでは呼び出し元に Administrator ロールまたは所有権が必要です。
残りの変数に影響を与えずに一部の変数だけを変更したい場合は、代わりに 変数の追加・編集 を使用するか、特定のキーを削除するには 環境変数の削除 を使用してください。
パラメータ
string
必須
アプリケーション ID。
object
環境に設定したいキーと値の変数。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
あなたが定義したすべての環境変数のキーと値。
{
"status": "success",
"response": {
"TEST": "overwriteTest"
}
}
一般的なエラー
| コード | 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 文字を超えています。 |
⌘I
変数の上書き
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"
}
}