Leggi un file dell'applicazione

GET

apps

{app_id}

files

content

Leggi un file dell'applicazione

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

obbligatorio

La chiave API del tuo account. Puoi trovarla nelle impostazioni del tuo account.

Richiede una chiave API con lo scope files:read. Leggere File restituisce un singolo file all’interno di un’applicazione in esecuzione come JSON. Invia ?encoding=base64 per ricevere il file come stringa base64. È pensato per ispezionare o scaricare singoli file (config, log, piccoli asset) fino a 10 MB tramite l’API, non per trasferimenti massivi: usa Crea Snapshot per ottenere una copia completa dell’applicazione.

Senza encoding, la risposta è il vecchio oggetto { type: "Buffer", data: number[] }. Questo formato è deprecato dal 27 settembre 2026 e sarà rimosso il 27 marzo 2027, quando base64 diventerà il formato predefinito. Fino ad allora, le risposte nel vecchio formato includono gli header Deprecation e Sunset. Invia ?encoding=base64 in ogni richiesta.

Per vedere cosa è disponibile prima di leggere, chiama prima Elencare File. Per riscrivere un file, usa Crea/Modifica File, che accetta lo stesso contenuto base64 con encoding: "base64". Sulle applicazioni condivise in un workspace, chi effettua la richiesta deve avere il ruolo maintain o admin, e i membri senza il permesso sui file riservati non possono leggere .env o .env.production: la richiesta viene rifiutata con PERMISSION_DENIED prima che il file venga toccato.

Parametri

string

obbligatorio

L’ID dell’applicazione. Puoi trovarlo nell’URL della dashboard della tua applicazione.

string

obbligatorio

Il percorso del file che vuoi leggere, relativo alla radice della tua applicazione. Fino a 256 caratteri.

string

Invia base64 per ricevere il file come stringa base64. Qualsiasi altro valore risponde INVALID_ENCODING. Senza di esso, la risposta usa il formato Buffer deprecato.

Risposta

string

Indica se la chiamata è andata a buon fine: success in caso affermativo, error in caso contrario.

object

Il contenuto del file.

Mostra Attiva/disattiva oggetto

string

Sempre base64.

string

Il file, codificato in base64.

Decodifica data per ottenere i byte del file:

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

Errori comuni

Codice	HTTP	Significato
`INVALID_PATH`	400	Il parametro query `path` non ha superato la validazione (traversal, caratteri non validi o più lungo di 256 caratteri).
`INVALID_ENCODING`	400	`encoding` ha un valore diverso da `base64`.
`PERMISSION_DENIED`	403	Chi effettua la richiesta non ha il permesso del workspace per leggere un file riservato (`.env`, `.env.production`).
`FILE_NOT_FOUND`	404	Non esiste nessun file al percorso indicato.
`FILE_TOO_LARGE`	413	Il file supera 10 MB, il massimo che il file manager legge.

Vedi anche

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

Leggi un file dell'applicazione

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

Primi passi

Account

Applicazioni

Database

Workspace

IA

Leggi un file dell'applicazione

Parametri

Risposta

Errori comuni

Vedi anche

​Parametri

​Risposta

​Errori comuni

​Vedi anche

Parametri

Risposta

Errori comuni

Vedi anche