Obtener logs de la aplicación

GET

apps

{app_id}

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 está estrictamente limitado por tasa. Superar cualquiera de los límites devuelve 429 Too Many Requests:

1 solicitud cada 5 segundos por usuario, por aplicación.
20 solicitudes cada 10 segundos por usuario en todas las aplicaciones, seguido de un enfriamiento de 30 segundos.

Cuando recibas un 429, deja de consultar esa aplicación y espera al menos el tiempo de enfriamiento (~30 segundos) antes de reintentar.

Usa este endpoint solo para obtener una instantánea puntual de los logs (al abrir la pestaña de logs o hacer una actualización manual). Para logs en vivo y continuos, usa el endpoint de Logs en tiempo real (SSE), que transmite los logs en tiempo real sin alcanzar este límite de tasa.

string

requerido

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

Este endpoint obtiene el búfer más reciente de stdout/stderr de la aplicación directamente desde el cluster: es una instantánea de corta duración, no un stream. stdout y stderr se devuelven concatenados en el orden en que se escribieron, sin distinción por línea entre ambos, a diferencia del evento de Logs en tiempo real, que antepone a cada línea el id de su stream. Úsalo cuando necesites un vistazo puntual a la salida reciente, por ejemplo al renderizar la pestaña de logs al cargar la página o después de un botón de actualización manual. Devuelve 404 cuando la aplicación está apagada, nunca se ha desplegado, o el cluster devuelve un error transitorio. Los miembros de un workspace con acceso a la aplicación pueden llamarlo igual que el propietario.

Parámetros

string

requerido

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

Respuesta

string

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

object

El contenido de la respuesta.

Mostrar Alternar objeto

string

Los últimos logs de la aplicación.

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

Logs en tiempo realEstablece una conexión de Server-Sent Events (SSE) para recibir el feed en tiempo real de tu aplicación (logs, métricas en vivo, estado, progreso del deploy). Al conectar, se envían las 200 líneas de log más recientes, seguidas de las nuevas actualizaciones. La conexión puede mantenerse hasta 10 minutos.

Obtener logs de la aplicación

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!"
    }
}

​Parámetros

​Respuesta

Parámetros

Respuesta