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

