アプリケーションファイルの作成・更新
PUT /v2/apps//files でアプリケーションにファイルを作成または上書きします。バイナリファイルは base64 で送信し、1 ファイル最大 10 MB、再起動は不要です。
PUT
アプリケーションファイルの作成・更新
files:write スコープを持つ API キーが必要です。
ファイルの作成・変更は、実行中のアプリケーション内の path に content を書き込みます。ファイルが存在しない場合は作成し、存在する場合は上書きします。バイナリファイルの場合は、推奨形式である base64 でエンコードした content を encoding: "base64" とともに送信してください。content には、テキストファイル用の UTF-8 文字列、バイト値の配列([104, 105])、または { type: "Buffer", data: number[] } オブジェクトも指定できます。空の content("" または [])は空のファイルを書き込みます。1 回の書き込みはデコード後のバイト数で最大 10 MB です。書き込みはユーザーごとに 5 秒間に 10 リクエストまでに制限されています。設定値の調整や生成ファイルの配置など、アプリケーション全体を再アップロードせずに小さな範囲の変更を行いたい場合に使用してください。一括変更や .zip の場合は、代わりに アプリケーションのコミット を使用してください。
squarecloud.app または squarecloud.config への書き込みは特別に扱われます。プラットフォームはこれをアプリケーションの設定(表示名、説明、メモリ、autorestart、サブドメイン)として解析し、各フィールドを検証します。値が無効な場合、ファイルへの書き込みは行われず、代わりに特定のエラーコード(INVALID_MEMORY や INVALID_SUBDOMAIN など)が返されます。これらの設定の書き換えは、ユーザーごとに 15 秒あたり 1 リクエストにレート制限されています。
ワークスペースで共有されているアプリケーションでは、呼び出し元に maintain または admin のロールが必要です。制限ファイルへのアクセス権限を持たないメンバーは、.env のような除外パスへの書き込みがブロックされます。他のファイルマネージャーのルートと同様、この操作はアプリケーションを再起動しません。新しいプロセスが必要な変更を反映するには アプリケーションの再起動 を呼び出してください。
パラメータ
string
必須
アプリケーションの ID。アプリケーションのダッシュボードの URL から確認できます。
string
必須
ファイルを作成するパス。最大 256 文字です。例: /test.txt
string | number[]
必須
作成するファイルの内容。
encoding が base64 の場合は base64、それ以外の場合は UTF-8 文字列またはバイトの配列です。string
content が base64 でエンコードされたファイルである場合は base64 を指定します。バイナリファイルに推奨されます。レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。一般的なエラー
関連項目
- CLI:
squarecloud app file write - SDK:
api.apps.files.write()(JavaScript),client.apps.files.write()(Python),c.Apps.Files.Write()(Go)

