アプリケーション - 環境変数
変数の追加・編集
環境変数を追加または編集します。
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"
}
}
このエンドポイントは、新しい環境変数を追加したり、特定の変数だけを他に影響を与えずに更新したりする場合に使用します。リクエストボディに含まれていない既存の変数はそのまま残るため、API キーを 1 つだけローテーションするような差分更新に最も安全な選択肢です。
静的アプリケーションは環境変数に対応しておらず、エラーが返されます。変数の総数はアプリケーションごとに 256 個までで、キーは 1024 文字、値は 4096 文字までに制限されています。ワークスペースで共有されているアプリケーションでは、呼び出し元に Administrator ロールまたは所有権が必要です。
マージではなく変数セット全体を置き換えたい場合は、変数の上書き を使用してください。特定のキーを削除するには 環境変数の削除 を、現在の値を確認するには 変数一覧の取得 を参照してください。
パラメータ
string
必須
アプリケーション ID。
object
必須
環境変数のキーと値。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
あなたが定義したすべての環境変数のキーと値。
{
"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 文字を超えています。 |
⌘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"
}
}