アプリケーションファイルの読み取り

GET

apps

{app_id}

files

content

アプリケーションファイルの読み取り

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/files/content \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/files/content"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/files/content', 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}/files/content",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/files/content"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/files/content")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "encoding": "base64",
        "data": "Y29uc29sZS5sb2coIkhlbGxvLCBTcXVhcmUgQ2xvdWQhIik7Cg=="
    }
}

string

必須

アカウントの API キーです。これはアカウント設定で確認できます。

files:read スコープを持つ API キーが必要です。ファイルの読み取りは、実行中のアプリケーション内にある 1 つのファイルを JSON として返します。?encoding=base64 を送信すると、ファイルを base64 文字列として受け取れます。これは設定ファイルやログ、小さなアセットなど最大 10 MB の個々のファイルを API 経由で確認・ダウンロードするためのものであり、一括転送を目的としていません。アプリケーション全体のコピーを取得したい場合は、代わりにスナップショットの作成を使用してください。

encoding を指定しない場合、レスポンスは従来の { type: "Buffer", data: number[] } オブジェクトになります。この形式は 2026 年 9 月 27 日から非推奨 となり、2027 年 3 月 27 日 に削除され、その時点で base64 がデフォルトになります。それまでの間、従来形式のレスポンスには Deprecation ヘッダーと Sunset ヘッダーが付与されます。すべてのリクエストで ?encoding=base64 を送信してください。

読み取る前に利用可能なファイルを確認するには、まずファイルの一覧表示を呼び出してください。ファイルを書き戻すには、同じ base64 コンテンツを encoding: "base64" とともに受け付けるファイルの作成・変更を使用します。ワークスペースで共有されているアプリケーションでは、呼び出し元に maintain または admin のロールが必要です。制限ファイルへのアクセス権限を持たないメンバーは .env や .env.production を読み取ることができず、ファイルに触れる前にリクエストは PERMISSION_DENIED で拒否されます。

パラメーター

string

必須

アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。

string

必須

読み取りたいファイルのパス。アプリケーションのルートからの相対パスで、最大 256 文字です。

string

base64 を送信すると、ファイルを base64 文字列として受け取れます。それ以外の値は INVALID_ENCODING を返します。指定しない場合、レスポンスは非推奨の Buffer 形式になります。

レスポンス

string

呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。

object

ファイルの内容。

表示オブジェクトを切り替え

string

常に base64 です。

string

base64 でエンコードされたファイル。

data をデコードすると、ファイルのバイト列が得られます。

const bytes = Buffer.from(data, "base64");

const bytes = Uint8Array.fromBase64(data);
// Older browsers: Uint8Array.from(atob(data), (c) => c.charCodeAt(0))

import base64

content = base64.b64decode(data)

{
    "status": "success",
    "response": {
        "encoding": "base64",
        "data": "Y29uc29sZS5sb2coIkhlbGxvLCBTcXVhcmUgQ2xvdWQhIik7Cg=="
    }
}

一般的なエラー

コード	HTTP	説明
`INVALID_PATH`	400	クエリパラメータ `path` の検証に失敗しました（パストラバーサル、無効な文字、または 256 文字を超えている）。
`INVALID_ENCODING`	400	`encoding` の値が `base64` 以外です。
`PERMISSION_DENIED`	403	呼び出し元に、制限されたファイル（`.env`、`.env.production`）を読み取るためのワークスペース権限がありません。
`FILE_NOT_FOUND`	404	指定されたパスにファイルが存在しません。
`FILE_TOO_LARGE`	413	ファイルが、ファイルマネージャーで読み取れる上限の 10 MB を超えています。

関連項目

CLI: squarecloud app file read
SDK: api.apps.files.read() (JavaScript), client.apps.files.read() (Python), c.Apps.Files.Read() (Go)

アプリケーションファイルの読み取り

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/files/content \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/files/content"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/files/content', 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}/files/content",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.squarecloud.app/v2/apps/{app_id}/files/content"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/files/content")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "encoding": "base64",
        "data": "Y29uc29sZS5sb2coIkhlbGxvLCBTcXVhcmUgQ2xvdWQhIik7Cg=="
    }
}

はじめに

アカウント