環境変数の追加・編集
POST /v2/apps/:app_id/envs で環境変数を追加または更新します。ボディに含めない変数はそのまま残るため、単一のキーのローテーションに適しています。
POST
環境変数の追加・編集
envs:write スコープを持つ API キーが必要です。書き込み権限は読み取り権限を含みません。envs:read がない場合、リクエストで送信していない変数がレスポンスに含まれることはありません。
このエンドポイントは、新しい環境変数を追加したり、特定の変数だけを他に影響を与えずに更新したりする場合に使用します。リクエストボディに含まれていない既存の変数はそのまま残るため、API キーを 1 つだけローテーションするような差分更新に最も安全な選択肢です。
静的アプリケーションは環境変数に対応しておらず、エラーが返されます。変数の総数はアプリケーションごとに 256 個までで、キーは 1024 文字、値は 4096 文字までに制限されています(値を囲むために追加される引用符は数えません)。ワークスペースで共有されているアプリケーションでは、呼び出し元に admin のロールまたは所有権が必要です。
アプリケーションはシェルで変数を読み込むため、空白やシェルの特殊文字(& や ; など)を含む値は、ダッシュボードと同じようにシングルクォートで囲んで保存され、その形で返されます。すでに引用符で囲んだ値は送信したとおりに保持されます。別の変数への参照($HOST、${HOST}。単独でも、ダブルクォートの中でも可)はそのまま機能しますが、コマンド置換($(...) やバッククォート)は常にプレーンテキストとして保存されます。名前に使えるのは英字、数字、アンダースコア、ドット、ハイフンで、数字で始めることはできません。
マージではなく変数セット全体を置き換えたい場合は、変数の上書き を使用してください。特定のキーを削除するには 環境変数の削除 を、現在の値を確認するには 変数一覧の取得 を参照してください。
パラメータ
string
必須
アプリケーション ID。
object
必須
環境変数のキーと値。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
変更後のアプリケーションのすべての環境変数。
envs:read スコープを持たない API キーには、このリクエストで送信した変数のみが返されます。一般的なエラー
関連項目
- CLI:
squarecloud app env set - SDK:
api.apps.envs.set()(JavaScript),client.apps.envs.set()(Python),c.Apps.Envs.Set()(Go)

