Ler arquivo - Square Cloud

GET

apps

{app_id}

files

content

Ler arquivo

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

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/files/content")
  .header("Authorization", "<authorization>")
  .asString();

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

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

Ler arquivo retorna os bytes brutos de um único arquivo dentro de uma aplicação em execução, codificados como um objeto JSON { type: "Buffer", data: number[] }, em vez de um stream. É indicado para inspecionar ou baixar arquivos individuais (configurações, logs, assets pequenos) através da API, não para transferências em massa; use Criar snapshot para obter uma cópia completa da aplicação. Para ver o que está disponível antes de ler, chame Listar arquivos primeiro. Para gravar um arquivo de volta, use Criar/modificar arquivo, que aceita o mesmo formato Buffer para conteúdo binário. Em aplicações compartilhadas em workspace, quem chama precisa da função Mantenedor ou Administrador, e membros sem a permissão de arquivos restritos não podem ler .env ou .env.production; a requisição é rejeitada com PERMISSION_DENIED antes de o arquivo ser tocado.

Parâmetros

app_id

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.

path

string

obrigatório

O caminho para o arquivo que você deseja ler. Este caminho é relativo à raiz da sua aplicação.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

response

object

O conteúdo do arquivo.

Mostrar Alternar objeto

type

string

O tipo dos dados. É “Buffer” para dados binários.

data

array

Os dados do arquivo representados como um array de números. Esses números representam os bytes do arquivo.

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

Erros comuns

Código	HTTP	Significado
`INVALID_PATH`	400	O parâmetro de consulta `path` falhou na validação (travessia, caracteres inválidos ou muito longo).
`PERMISSION_DENIED`	403	Quem chama não tem a permissão de workspace para ler um arquivo restrito (`.env`, `.env.production`).
`FILE_NOT_FOUND`	404	Não existe nenhum arquivo no caminho informado.
`FILE_TOO_LARGE`	413	O arquivo é grande demais para ser lido pelo gerenciador de arquivos.

Listar arquivosListar os arquivos da sua aplicação.

Ler arquivo

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

}

HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/files/content")
  .header("Authorization", "<authorization>")
  .asString();

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

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns