Datei einer Anwendung lesen

GET

apps

{app_id}

files

content

Datei einer Anwendung lesen

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

erforderlich

Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.

Erfordert einen API-Schlüssel mit dem Scope files:read. Datei lesen gibt eine einzelne Datei innerhalb einer laufenden Anwendung als JSON zurück. Sende ?encoding=base64, um die Datei als base64-String zu erhalten. Der Endpunkt ist für das Ansehen oder Herunterladen einzelner Dateien (Konfigurationen, Logs, kleine Assets) von bis zu 10 MB über die API gedacht, nicht für Massentransfers: Nutze stattdessen Snapshot erstellen, um eine vollständige Kopie der Anwendung zu erhalten.

Ohne encoding ist die Antwort das veraltete Objekt { type: "Buffer", data: number[] }. Dieses Format ist seit dem 27. September 2026 veraltet und wird am 27. März 2027 entfernt, wenn base64 zum Standard wird. Bis dahin tragen Antworten im alten Format die Header Deprecation und Sunset. Sende ?encoding=base64 in jeder Anfrage.

Um vorab zu sehen, was verfügbar ist, rufe zuerst Dateien auflisten auf. Um eine Datei zurückzuschreiben, nutze Datei erstellen/ändern, das denselben base64-Inhalt mit encoding: "base64" entgegennimmt. Bei Workspace-geteilten Anwendungen benötigt der Aufrufer die Rolle maintain oder admin, und Mitglieder ohne die Berechtigung für eingeschränkte Dateien können .env oder .env.production nicht lesen, die Anfrage wird mit PERMISSION_DENIED abgelehnt, bevor die Datei angefasst wird.

Parameter

string

erforderlich

Die ID der Anwendung. Du findest sie in der URL des Dashboards deiner Anwendung.

string

erforderlich

Der Pfad zur Datei, die du lesen möchtest, relativ zum Stammverzeichnis deiner Anwendung. Bis zu 256 Zeichen.

string

Sende base64, um die Datei als base64-String zu erhalten. Jeder andere Wert antwortet mit INVALID_ENCODING. Ohne diesen Parameter nutzt die Antwort das veraltete Buffer-Format.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.

object

Der Inhalt der Datei.

Anzeigen Objekt umschalten

string

Immer base64.

string

Die Datei, base64-kodiert.

Dekodiere data, um die Bytes der Datei zu erhalten:

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

Häufige Fehler

Code	HTTP	Bedeutung
`INVALID_PATH`	400	Der Query-Parameter `path` hat die Validierung nicht bestanden (Traversal, ungültige Zeichen oder länger als 256 Zeichen).
`INVALID_ENCODING`	400	`encoding` hat einen anderen Wert als `base64`.
`PERMISSION_DENIED`	403	Dem Aufrufer fehlt die Workspace-Berechtigung, um eine eingeschränkte Datei (`.env`, `.env.production`) zu lesen.
`FILE_NOT_FOUND`	404	Unter dem angegebenen Pfad existiert keine Datei.
`FILE_TOO_LARGE`	413	Die Datei ist größer als 10 MB, das Maximum, das der Dateimanager liest.

Siehe auch

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

Datei einer Anwendung lesen

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

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Datei einer Anwendung lesen

Parameter

Antwort

Häufige Fehler

Siehe auch

​Parameter

​Antwort

​Häufige Fehler

​Siehe auch

Parameter

Antwort

Häufige Fehler

Siehe auch