Leer archivo - Square Cloud

GET

apps

{app_id}

files

content

Leer archivo

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

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Leer archivo devuelve los bytes crudos de un único archivo dentro de una aplicación en ejecución, codificados como un objeto JSON { type: "Buffer", data: number[] } en lugar de un stream. Está pensado para inspeccionar o descargar archivos individuales (configuraciones, logs, assets pequeños) a través de la API, no para transferencias masivas; usa Crear snapshot para obtener una copia completa de la aplicación. Para ver qué hay disponible antes de leer, llama primero a Listar archivos. Para volver a escribir un archivo, usa Crear/Modificar archivo, que acepta el mismo formato Buffer para contenido binario. En aplicaciones compartidas en un workspace, quien llama necesita el rol de Maintainer o Administrador, y los miembros sin el permiso de archivos restringidos no pueden leer .env ni .env.production; la solicitud se rechaza con PERMISSION_DENIED antes de tocar el archivo.

Parámetros

string

requerido

El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.

string

requerido

La ruta del archivo que quieres leer. Es relativa a la raíz de tu aplicación.

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

object

El contenido del archivo.

Mostrar Alternar objeto

string

El tipo de los datos. Es “Buffer” para datos binarios.

array

Los datos del archivo representados como un array de números. Estos números representan los bytes del archivo.

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

Errores comunes

Código	HTTP	Significado
`INVALID_PATH`	400	El parámetro de consulta `path` falló la validación (traversal, caracteres inválidos o demasiado largo).
`PERMISSION_DENIED`	403	Quien llama no tiene el permiso de workspace para leer un archivo restringido (`.env`, `.env.production`).
`FILE_NOT_FOUND`	404	No existe ningún archivo en la ruta indicada.
`FILE_TOO_LARGE`	413	El archivo es demasiado grande para leerse a través del administrador de archivos.

Listar archivosLista los archivos de tu aplicación.

Leer archivo

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

​Parámetros

​Respuesta

​Errores comunes

Parámetros

Respuesta

Errores comunes