Read File - Square Cloud

GET

apps

{app_id}

files

content

Read File

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": {
        "type": "Buffer",
        "data": [
            112,
            111,
            120,
            97,
            44,
            32,
            116,
            97,
            32,
            113,
            117,
            101,
            114,
            101,
            110,
            100,
            111,
            32,
            99,
            111,
            112,
            105,
            97,
            114,
            32,
            97,
            116,
            195,
            169,
            32,
            111,
            32,
            98,
            117,
            102,
            102,
            101,
            114,
            63
        ]
    }
}

string

required

The API key for your account. You can find this in your account settings.

Read File returns the raw bytes of a single file inside a running application, encoded as a JSON { type: "Buffer", data: number[] } object rather than a stream. It is meant for inspecting or downloading individual files (configs, logs, small assets) through the API, not for bulk transfers, use Create Snapshot to pull a full copy of the application instead. To see what is available before reading, call List Files first. To write a file back, use Create/Modify File, which accepts the same Buffer format for binary content. On workspace-shared applications the caller needs the Maintainer or Administrator role, and members without the restricted-files permission cannot read .env or .env.production, the request is rejected with PERMISSION_DENIED before the file is touched.

Parameters

string

required

The ID of the application. You can find this in the URL of your application’s dashboard.

string

required

The path to the file you want to read. This is relative to the root of your application.

Response

string

Indicates whether the call was successful.. success if successful, error if not.

object

The contents of the file.

Show Toggle object

string

The type of the data. It is “Buffer” for binary data.

array

The data of the file represented as an array of numbers. These numbers represent the bytes of the file.

{
    "status": "success",
    "response": {
        "type": "Buffer",
        "data": [
            112,
            111,
            120,
            97,
            44,
            32,
            116,
            97,
            32,
            113,
            117,
            101,
            114,
            101,
            110,
            100,
            111,
            32,
            99,
            111,
            112,
            105,
            97,
            114,
            32,
            97,
            116,
            195,
            169,
            32,
            111,
            32,
            98,
            117,
            102,
            102,
            101,
            114,
            63
        ]
    }
}

Common errors

Code	HTTP	Meaning
`INVALID_PATH`	400	The `path` query parameter failed validation (traversal, invalid characters, or too long).
`PERMISSION_DENIED`	403	The caller lacks the workspace permission to read a restricted file (`.env`, `.env.production`).
`FILE_NOT_FOUND`	404	No file exists at the given path.
`FILE_TOO_LARGE`	413	The file is too large to read through the file manager.

List FilesList the files of your application.

Read File

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": {
        "type": "Buffer",
        "data": [
            112,
            111,
            120,
            97,
            44,
            32,
            116,
            97,
            32,
            113,
            117,
            101,
            114,
            101,
            110,
            100,
            111,
            32,
            99,
            111,
            112,
            105,
            97,
            114,
            32,
            97,
            116,
            195,
            169,
            32,
            111,
            32,
            98,
            117,
            102,
            102,
            101,
            114,
            63
        ]
    }
}

​Parameters

​Response

​Common errors

Parameters

Response

Common errors