Lire un fichier - Square Cloud

GET

apps

{app_id}

files

content

Lire un fichier

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

requis

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

Read File renvoie les octets bruts d’un fichier unique à l’intérieur d’une application en cours d’exécution, encodés sous la forme d’un objet JSON { type: "Buffer", data: number[] } plutôt que d’un flux. Il est destiné à inspecter ou télécharger des fichiers individuels (configurations, logs, petits assets) 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. 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 format Buffer pour le contenu binaire. Sur les applications partagées en workspace, l’appelant doit avoir le rôle Maintainer ou Administrator, 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. Il est relatif à la racine de votre application.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

object

Le contenu du fichier.

Afficher Afficher l'objet

string

Le type des données. Il vaut “Buffer” pour les données binaires.

array

Les données du fichier représentées sous forme d’un tableau de nombres. Ces nombres représentent les octets du fichier.

{
    "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
        ]
    }
}

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 trop long).
`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 est trop volumineux pour être lu via le gestionnaire de fichiers.

Lister les fichiersLister les fichiers de votre application.

Lire un fichier

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
        ]
    }
}

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes