Leer un archivo de la aplicación

GET

apps

{app_id}

files

content

Leer un archivo de la aplicación

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

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Requiere una clave de API con el scope files:read. Leer archivo devuelve un único archivo dentro de una aplicación en ejecución como JSON. Envía ?encoding=base64 para obtener el archivo como una cadena base64. Está pensado para inspeccionar o descargar archivos individuales (configuraciones, logs, assets pequeños) de hasta 10 MB a través de la API, no para transferencias masivas: usa Crear snapshot para obtener una copia completa de la aplicación.

Sin encoding, la respuesta es el objeto heredado { type: "Buffer", data: number[] }. Este formato está obsoleto desde el 27 de septiembre de 2026 y se eliminará el 27 de marzo de 2027, cuando base64 pase a ser el formato predeterminado. Hasta entonces, las respuestas heredadas incluyen los encabezados Deprecation y Sunset. Envía ?encoding=base64 en todas las solicitudes.

Para ver qué hay disponible antes de leer, llama primero a Listar archivos. Para volver a escribir un archivo, usa Crear/Modificar archivo, que recibe el mismo contenido base64 con encoding: "base64". En aplicaciones compartidas en un workspace, quien llama necesita el rol maintain o admin, y los miembros sin el permiso de archivos restringidos no pueden leer .env ni .env.production; la solicitud se rechaza con PERMISSION_DENIED antes de tocar el archivo.

Parámetros

string

requerido

El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.

string

requerido

La ruta del archivo que quieres leer, relativa a la raíz de tu aplicación. Hasta 256 caracteres.

string

Envía base64 para recibir el archivo como una cadena base64. Cualquier otro valor responde INVALID_ENCODING. Sin él, la respuesta usa el formato Buffer obsoleto.

Respuesta

string

Indica si la llamada fue exitosa: success si lo fue, error si no.

object

El contenido del archivo.

Mostrar Alternar objeto

string

Siempre base64.

string

El archivo, codificado en base64.

Decodifica data para obtener los bytes del archivo:

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

Errores comunes

Código	HTTP	Significado
`INVALID_PATH`	400	El parámetro de consulta `path` falló la validación (traversal, caracteres inválidos o más de 256 caracteres).
`INVALID_ENCODING`	400	`encoding` tiene un valor distinto de `base64`.
`PERMISSION_DENIED`	403	Quien llama no tiene el permiso de workspace para leer un archivo restringido (`.env`, `.env.production`).
`FILE_NOT_FOUND`	404	No existe ningún archivo en la ruta indicada.
`FILE_TOO_LARGE`	413	El archivo supera los 10 MB, el máximo que lee el administrador de archivos.

Relacionado

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

Leer un archivo de la aplicación

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

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Leer un archivo de la aplicación

Parámetros

Respuesta

Errores comunes

Relacionado

​Parámetros

​Respuesta

​Errores comunes

​Relacionado

Parámetros

Respuesta

Errores comunes

Relacionado