Lire un fichier d'une application

GET

apps

{app_id}

files

content

Lire un fichier d'une application

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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope files:read. Read File renvoie un fichier unique à l’intérieur d’une application en cours d’exécution, sous forme de JSON. Envoyez ?encoding=base64 pour recevoir le fichier sous forme de chaîne base64. Il est destiné à inspecter ou télécharger des fichiers individuels (configurations, logs, petits assets) de 10 Mo maximum via l’API, pas à des transferts en masse : utilisez plutôt Créer un snapshot pour récupérer une copie complète de l’application.

Sans encoding, la réponse est l’ancien objet { type: "Buffer", data: number[] }. Ce format est déprécié depuis le 27 septembre 2026 et sera supprimé le 27 mars 2027, date à laquelle base64 deviendra le format par défaut. D’ici là, les réponses dans l’ancien format portent les en-têtes Deprecation et Sunset. Envoyez ?encoding=base64 dans chaque requête.

Pour voir ce qui est disponible avant de lire, appelez d’abord Lister les fichiers. Pour réécrire un fichier, utilisez Créer/Modifier un fichier, qui accepte le même contenu base64 avec encoding: "base64". Sur les applications partagées en workspace, l’appelant doit avoir le rôle maintain ou admin, et les membres sans la permission des fichiers restreints ne peuvent pas lire .env ou .env.production, la requête est rejetée avec PERMISSION_DENIED avant que le fichier ne soit touché.

Paramètres

string

requis

L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.

string

requis

Le chemin vers le fichier que vous souhaitez lire, relatif à la racine de votre application. Jusqu’à 256 caractères.

string

Envoyez base64 pour recevoir le fichier sous forme de chaîne base64. Toute autre valeur répond INVALID_ENCODING. Sans ce paramètre, la réponse utilise le format Buffer déprécié.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

object

Le contenu du fichier.

Afficher Afficher l'objet

string

Toujours base64.

string

Le fichier, encodé en base64.

Décodez data pour obtenir les octets du fichier :

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

Erreurs courantes

Code	HTTP	Signification
`INVALID_PATH`	400	Le paramètre de requête `path` a échoué la validation (traversée de répertoire, caractères invalides, ou plus de 256 caractères).
`INVALID_ENCODING`	400	`encoding` a une valeur autre que `base64`.
`PERMISSION_DENIED`	403	L’appelant n’a pas la permission workspace nécessaire pour lire un fichier restreint (`.env`, `.env.production`).
`FILE_NOT_FOUND`	404	Aucun fichier n’existe au chemin indiqué.
`FILE_TOO_LARGE`	413	Le fichier dépasse 10 Mo, le maximum que le gestionnaire de fichiers peut lire.

Voir aussi

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

Lire un fichier d'une application

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

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Lire un fichier d'une application

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi