Ler um arquivo da aplicação

GET

apps

{app_id}

files

content

Ler um arquivo da aplicação

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

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Requer uma chave de API com o escopo files:read. Ler arquivo retorna um único arquivo dentro de uma aplicação em execução como JSON. Envie ?encoding=base64 para receber o arquivo como uma string base64. É indicado para inspecionar ou baixar arquivos individuais (configurações, logs, assets pequenos) de até 10 MB através da API, não para transferências em massa: use Criar snapshot para obter uma cópia completa da aplicação.

Sem encoding, a resposta é o objeto legado { type: "Buffer", data: number[] }. Esse formato está obsoleto desde 27 de setembro de 2026 e será removido em 27 de março de 2027, quando base64 passará a ser o padrão. Até lá, as respostas legadas trazem os headers Deprecation e Sunset. Envie ?encoding=base64 em toda requisição.

Para ver o que está disponível antes de ler, chame Listar arquivos primeiro. Para gravar um arquivo de volta, use Criar/modificar arquivo, que recebe o mesmo conteúdo base64 com encoding: "base64". Em aplicações compartilhadas em workspace, quem chama precisa da função maintain ou admin, e membros sem a permissão de arquivos restritos não podem ler .env ou .env.production; a requisição é rejeitada com PERMISSION_DENIED antes de o arquivo ser tocado.

Parâmetros

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL da sua aplicação no dashboard.

string

obrigatório

O caminho para o arquivo que você deseja ler, relativo à raiz da sua aplicação. Até 256 caracteres.

string

Envie base64 para receber o arquivo como uma string base64. Qualquer outro valor responde INVALID_ENCODING. Sem ele, a resposta usa o formato Buffer obsoleto.

Resposta

string

Indica se a chamada foi bem-sucedida: success se foi, error se não.

object

O conteúdo do arquivo.

Mostrar Alternar objeto

string

Sempre base64.

string

O arquivo, codificado em base64.

Decodifique data para obter os bytes do arquivo:

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=="
    }
}

Erros comuns

Código	HTTP	Significado
`INVALID_PATH`	400	O parâmetro de consulta `path` falhou na validação (travessia, caracteres inválidos ou mais de 256 caracteres).
`INVALID_ENCODING`	400	`encoding` tem um valor diferente de `base64`.
`PERMISSION_DENIED`	403	Quem chama não tem a permissão de workspace para ler um arquivo restrito (`.env`, `.env.production`).
`FILE_NOT_FOUND`	404	Não existe nenhum arquivo no caminho informado.
`FILE_TOO_LARGE`	413	O arquivo é maior que 10 MB, o máximo que o gerenciador de arquivos lê.

Relacionados

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

Ler um arquivo da aplicação

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=="
    }
}

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Ler um arquivo da aplicação

Parâmetros

Resposta

Erros comuns

Relacionados

​Parâmetros

​Resposta

​Erros comuns

​Relacionados

Parâmetros

Resposta

Erros comuns

Relacionados