Obtener Estado de la Aplicación

GET

apps

{app_id}

status

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

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

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

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

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": {
        "cpu": "0.01%",
        "ram": "31.79",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

string

requerido

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

Devuelve las cifras actuales de CPU, RAM, almacenamiento, red y tiempo de actividad de la aplicación, formateadas por defecto como cadenas legibles para humanos (por ejemplo, "31.79" MB, "602 KB ↑ 134 KB ↓"). Pasa rawData=true para obtener los mismos campos como números en bruto, lo cual es más fácil de trabajar si vas a graficar los valores tú mismo. Si también tienes abierta una conexión de Logs en tiempo real para la misma aplicación, prefiere los eventos status de ese stream: mientras una conexión en tiempo real esté activa, las cifras de este endpoint pueden retrasarse hasta cerca de un minuto. Para comprobar todas las aplicaciones a la vez en lugar de una por una, consulta Estado de Todas las Aplicaciones.

Parámetros

string

requerido

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

boolean

Si deseas los datos en bruto. Con True, devuelve los valores en bytes.

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

El uso de CPU de la aplicación.

string

El uso de RAM de la aplicación.

string

El estado de la aplicación.

boolean

Indica si la aplicación se está ejecutando actualmente.

string

El almacenamiento utilizado por la aplicación.

object

Mostrar Alternar objeto

string

El uso total de red de la aplicación.

string

El uso de red actual de la aplicación.

number

El tiempo de actividad de la aplicación en milisegundos.

{
    "status": "success",
    "response": {
        "cpu": "0.01%",
        "ram": "31.79",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

Errores comunes

Código	HTTP	Significado
`APP_NOT_FOUND`	404	La aplicación no existe o no pertenece a quien realiza la llamada.

Obtener logs de la aplicaciónRecopila las últimas 1000 líneas de logs de tu aplicación. Tiene un límite de 1 solicitud cada 5 segundos.

Obtener Estado de la Aplicación

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

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

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

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

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": {
        "cpu": "0.01%",
        "ram": "31.79",
        "status": "running",
        "running": true,
        "storage": "2.72MB",
        "network": {
            "total": "602 KB ↑ 134 KB ↓",
            "now": "14 KB ↑ 3.3 KB ↓"
        },
        "uptime": 1662927833666
    }
}

​Parámetros

​Respuesta

​Errores comunes

Parámetros

Respuesta

Errores comunes