Skip to main content
Todos los métodos de esta página están en api.apps y reciben primero el id de la aplicación. Un appId también puede ser el id compuesto <appId>-<workspaceId> de una aplicación compartida a través de un workspace.
Para listar tus aplicaciones, usa api.account.me(): su array applications contiene todas las aplicaciones que la clave puede ver.

Obtener una aplicación

Estado

status(appId) devuelve el estado en vivo con valores formateados:
Pasa { raw: true } para obtener números en su lugar (cpu en %, ram en MB, network.total y network.now como pares de bytes [in, out]):
uptime es una marca de tiempo (cuándo se inició la aplicación), no una duración. Usa Date.now() - status.uptime para saber cuánto tiempo lleva en marcha.

Estado de todas las aplicaciones

statusAll() devuelve un resumen por cada aplicación que la clave puede ver, en una sola petición. cpu y ram solo están presentes mientras la aplicación se ejecuta.

Iniciar, detener y reiniciar

El servidor mantiene estas llamadas abiertas hasta que el contenedor actúa, así que esperan al menos 120 s antes de agotar el tiempo. Cuando la plataforma rechaza la acción, la llamada lanza un SquareCloudAPIError con estado 409, un code y un mensaje vacío: “Ya iniciada” y “ya detenida” también son errores. Si para ti significan éxito, gestiónalos:

Logs

logs(appId) devuelve la salida de consola más reciente como un único string ("" cuando no hay ninguna).
Para un stream de logs en vivo, usa Tiempo real.

Métricas

metrics(appId) devuelve las últimas 24 horas, un punto cada 5 minutos, del más reciente al más antiguo.

Dominios y balanceadores de carga

domains() lista los nombres de host por defecto y personalizados de todas las aplicaciones. loadBalancers() lista los dominios compartidos por varias aplicaciones, con el límite de tu plan.
Para configurar un dominio personalizado, consulta Red.

Eliminar una aplicación

La eliminación es permanente. Crea primero un snapshot si es posible que vuelvas a necesitar los archivos.

Próximos pasos

Commit y subida

Crea una aplicación a partir de un zip o envíale archivos.

Referencia de la API de aplicaciones

Los endpoints REST detrás de estos métodos.

Gestionar aplicaciones desde la CLI

Las mismas acciones desde la terminal.