Elenca i file dell'applicazione

GET

apps

{app_id}

files

Elenca i file dell'applicazione

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

obbligatorio

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

Richiede una chiave API con lo scope files:read. Elencare File restituisce i file e le directory in un dato percorso all’interno di un’applicazione, ogni voce con il proprio tipo, dimensione e data dell’ultima modifica. Usalo per esplorare lo storage di un’applicazione da una dashboard o uno script prima di leggere, scrivere o eliminare un file specifico. L’elenco riflette lo storage dell’applicazione sul suo nodo del cluster al momento della richiesta; non viene memorizzato in cache. Abbinalo a Leggere File per recuperare il contenuto di un file, o a Crea/Modifica File per scriverne uno. Omettere path elenca la radice dell’applicazione. 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 vedono mai .env o .env.production nei risultati: queste voci vengono filtrate dalla risposta invece di generare un errore.

Parametri

string

obbligatorio

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

string

obbligatorio

Il percorso della directory di cui vuoi elencare i file, fino a 256 caratteri. Il valore predefinito è la directory radice.

Risposta

string

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

array

L’elenco dei file e delle directory nel percorso specificato.

Mostra Attiva/disattiva oggetto

string

Il tipo della voce. Può essere file o directory.

string

Il nome del file o della directory.

number

La dimensione del file in byte. Per le directory è 0.

number

Il timestamp dell’ultima modifica del file o della directory in millisecondi dall’epoch.

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

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), oppure il cluster non è riuscito a leggere la directory.
`BLOCKED_PATH`	403	Il percorso richiesto si trova all’interno di una directory bloccata.
`FILE_NOT_FOUND`	404	La directory non esiste.

Vedi anche

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

Elenca i file dell'applicazione

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

Primi passi

Account

Applicazioni

Database

Workspace

IA

Elenca i file dell'applicazione

Parametri

Risposta

Errori comuni

Vedi anche

​Parametri

​Risposta

​Errori comuni

​Vedi anche

Parametri

Risposta

Errori comuni

Vedi anche