Obter logs

GET

apps

{app_id}

logs

Obter logs

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

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

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

	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}/logs")

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": {
        "logs": "Working!"
    }
}

Este endpoint tem limite de taxa rígido. Exceder qualquer um dos limites retorna 429 Too Many Requests:

1 requisição a cada 5 segundos por usuário e por aplicação.
20 requisições a cada 10 segundos por usuário, somando todas as aplicações, seguidas de um cooldown curto.

Ao receber um 429, pare o polling daquela aplicação e aguarde o fim do cooldown antes de tentar novamente.

Use este endpoint apenas para um snapshot pontual dos logs (ao abrir a aba de logs ou em um refresh manual). Para logs ao vivo e contínuos, use o endpoint Logs em tempo real (SSE), que transmite os logs em tempo real sem atingir este limite de taxa.

string

obrigatório

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

Requer uma chave de API com o escopo apps:read. Este endpoint busca o buffer mais recente de stdout/stderr da aplicação diretamente do cluster: é um snapshot pontual, não um stream. stdout e stderr são retornados concatenados na ordem em que foram escritos, sem distinção por linha entre os dois, diferente do evento de Logs em tempo real, que prefixa cada linha com o id do seu stream. Use este endpoint quando precisar de uma consulta pontual da saída recente, por exemplo ao renderizar a aba de logs no carregamento da página ou após um botão de atualização manual. Ele retorna 404 quando a aplicação está offline, nunca recebeu um deploy, ou o cluster retorna um erro transitório. Membros de workspace com acesso à aplicação podem chamá-lo da mesma forma que o proprietário.

Parâmetros

string

obrigatório

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

Resposta

string

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

object

O conteúdo da resposta.

Mostrar Alternar objeto

string

Os logs mais recentes da aplicação.

{
    "status": "success",
    "response": {
        "logs": "Working!"
    }
}

Erros comuns

Código	HTTP	Significado
`LOGS_UNAVAILABLE`	404	Os logs não puderam ser retornados: a aplicação está offline, nunca recebeu um deploy ou ocorreu um erro transitório. Tente novamente em instantes.

Relacionados

CLI: squarecloud app logs
SDKs: api.apps.logs() (JavaScript), client.apps.logs() (Python), c.Apps.Logs() (Go)

Obter logs

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

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

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

	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}/logs")

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": {
        "logs": "Working!"
    }
}

Primeiros passos

Conta

Aplicações

Bancos de dados

Workspaces

IA

Parâmetros

Resposta

Erros comuns

Relacionados

​Parâmetros

​Resposta

​Erros comuns

​Relacionados

Parâmetros

Resposta

Erros comuns

Relacionados