Dateien einer Anwendung auflisten

GET

apps

{app_id}

files

Dateien einer Anwendung auflisten

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/files \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/files', 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",
  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"

	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")

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": "file",
            "name": ".env",
            "size": 86,
            "lastModified": 1676168978000
        },
        {
            "type": "file",
            "name": ".gitignore",
            "size": 8,
            "lastModified": 1675125328000
        },
        {
            "type": "file",
            "name": "index.js",
            "size": 614,
            "lastModified": 1676168350000
        },
        {
            "type": "file",
            "name": "squarecloud.app",
            "size": 65,
            "lastModified": 1676169188000
        },
        {
            "type": "directory",
            "name": "src",
            "lastModified": 1676155738000
        }
    ]
}

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. Dateien auflisten gibt die Dateien und Verzeichnisse an einem bestimmten Pfad innerhalb einer Anwendung zurück, wobei jeder Eintrag seinen Typ, seine Größe und den Zeitpunkt der letzten Änderung enthält. Nutze es, um den Speicher einer Anwendung von einem Dashboard oder Skript aus zu durchsuchen, bevor du eine bestimmte Datei liest, schreibst oder löschst. Die Auflistung spiegelt den Speicher der Anwendung auf ihrem Cluster-Node zum Zeitpunkt der Anfrage wider; sie wird nicht zwischengespeichert. Kombiniere es mit Datei lesen, um den Inhalt einer Datei abzurufen, oder mit Datei erstellen/ändern, um eine zu schreiben. Wird path weggelassen, wird das Stammverzeichnis der Anwendung aufgelistet. Bei Workspace-geteilten Anwendungen benötigt der Aufrufer die Rolle maintain oder admin, und Mitglieder ohne die Berechtigung für eingeschränkte Dateien sehen .env oder .env.production nie in den Ergebnissen, diese Einträge werden aus der Antwort herausgefiltert statt einen Fehler auszulösen.

Parameter

string

erforderlich

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

string

erforderlich

Der Pfad des Verzeichnisses, dessen Dateien du auflisten möchtest, bis zu 256 Zeichen. Standard ist das Stammverzeichnis.

Antwort

string

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

array

Die Liste der Dateien und Verzeichnisse im angegebenen Pfad.

Anzeigen Objekt umschalten

string

Der Typ des Eintrags. Kann file oder directory sein.

string

Der Name der Datei oder des Verzeichnisses.

number

Die Größe der Datei in Bytes. Bei Verzeichnissen ist sie 0.

number

Der Zeitstempel der letzten Änderung der Datei oder des Verzeichnisses in Millisekunden seit der Epoche.

{
    "status": "success",
    "response": [
        {
            "type": "file",
            "name": ".env",
            "size": 86,
            "lastModified": 1676168978000
        },
        {
            "type": "file",
            "name": ".gitignore",
            "size": 8,
            "lastModified": 1675125328000
        },
        {
            "type": "file",
            "name": "index.js",
            "size": 614,
            "lastModified": 1676168350000
        },
        {
            "type": "file",
            "name": "squarecloud.app",
            "size": 65,
            "lastModified": 1676169188000
        },
        {
            "type": "directory",
            "name": "src",
            "lastModified": 1676155738000
        }
    ]
}

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), oder der Cluster konnte das Verzeichnis nicht lesen.
`BLOCKED_PATH`	403	Der angeforderte Pfad liegt in einem gesperrten Verzeichnis.
`FILE_NOT_FOUND`	404	Das Verzeichnis existiert nicht.

Siehe auch

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

Dateien einer Anwendung auflisten

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/files \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/files', 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",
  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"

	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")

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": "file",
            "name": ".env",
            "size": 86,
            "lastModified": 1676168978000
        },
        {
            "type": "file",
            "name": ".gitignore",
            "size": 8,
            "lastModified": 1675125328000
        },
        {
            "type": "file",
            "name": "index.js",
            "size": 614,
            "lastModified": 1676168350000
        },
        {
            "type": "file",
            "name": "squarecloud.app",
            "size": 65,
            "lastModified": 1676169188000
        },
        {
            "type": "directory",
            "name": "src",
            "lastModified": 1676155738000
        }
    ]
}

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Dateien einer Anwendung auflisten

Parameter

Antwort

Häufige Fehler

Siehe auch

​Parameter

​Antwort

​Häufige Fehler

​Siehe auch

Parameter

Antwort

Häufige Fehler

Siehe auch