Detalles de la aplicación
curl --request GET \
--url https://api.vertracloud.app/v1/apps/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/apps/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/apps/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/apps/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"response": {
"id": "app-abc123def456",
"cluster": 1,
"type": 1,
"name": "API Simples",
"description": "I have a description :)",
"owner_id": "user-123456789012345678",
"owner_plan": "pro",
"language": "javascript",
"ram": 128,
"status": "up",
"subdomain": "myapp.vertraweb.app",
"domains": [],
"public_url": "https://myapp.vertraweb.app",
"last_snapshot": "2026-03-09T15:51:47.234Z",
"main_file": "index.js",
"version": "recommended",
"start_command": "node index.js",
"build_command": null,
"offline_since": null,
"shield_cooldown": null,
"github": null,
"custom_image": null,
"deploy": {
"zero_downtime": "off",
"zero_downtime_active": false,
"auto_rollback": false,
"health_check_path": null
},
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-20T15:06:41.449Z"
}
}
Aplicaciones
Detalles de la aplicación
Devuelve los detalles de una aplicación a partir de su ID.
GET
/
v1
/
apps
/
{id}
Detalles de la aplicación
curl --request GET \
--url https://api.vertracloud.app/v1/apps/{id} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.vertracloud.app/v1/apps/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.vertracloud.app/v1/apps/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.vertracloud.app/v1/apps/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"response": {
"id": "app-abc123def456",
"cluster": 1,
"type": 1,
"name": "API Simples",
"description": "I have a description :)",
"owner_id": "user-123456789012345678",
"owner_plan": "pro",
"language": "javascript",
"ram": 128,
"status": "up",
"subdomain": "myapp.vertraweb.app",
"domains": [],
"public_url": "https://myapp.vertraweb.app",
"last_snapshot": "2026-03-09T15:51:47.234Z",
"main_file": "index.js",
"version": "recommended",
"start_command": "node index.js",
"build_command": null,
"offline_since": null,
"shield_cooldown": null,
"github": null,
"custom_image": null,
"deploy": {
"zero_downtime": "off",
"zero_downtime_active": false,
"auto_rollback": false,
"health_check_path": null
},
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-20T15:06:41.449Z"
}
}
string
requerido
El ID de la aplicación cuyos detalles quieres obtener. Si la aplicación pertenece a un workspace, pasa su ID en el parámetro de consulta
workspace_id.string
Si la aplicación pertenece a un workspace, el ID del workspace. Es obligatorio para los miembros del workspace que actúen sobre una aplicación que no les pertenece.
Respuesta
object
Los detalles de la aplicación.
Mostrar Mostrar objeto
Mostrar Mostrar objeto
string
El ID de la aplicación.
integer
El ID del clúster de la aplicación.
integer
El tipo de aplicación.
string
El nombre de la aplicación.
string
La descripción de la aplicación.
string
El ID del propietario de la aplicación.
string | null
El nombre del plan del propietario (por ejemplo,
pro o enterprise-8), o null si el propietario no tiene plan.string
El lenguaje de programación de la aplicación (por ejemplo,
javascript).integer
La RAM de la aplicación, en MB.
string
El estado de la aplicación:
up, down o building (creación en curso; la mayoría de las acciones responden 409 APP_BUILDING).string | null
El código del último fallo de build o de instalación, o
null tras un build correcto. Es uno de
BUILD_FAILED, BUILD_TIMEOUT, BUILD_INTERRUPTED, INSTALL_FAILED, INSTALL_OUT_OF_MEMORY,
INSTALL_TIMEOUT o INSTALL_SHIELD_BLOCKED. El detalle está en los logs de la aplicación; consulta
Errores para saber qué hacer con cada código.string | null
El subdominio de la aplicación, si aplica.
APIApplicationDomain[]
Los dominios personalizados de la aplicación, con su estado, el estado del SSL, el puerto, el prefijo de ruta y la redirección. Vacío si no tiene ninguno.
Cada elemento se describe en Listar dominios de la aplicación.
string | null
La URL pública canónica de la aplicación, ya calculada por el servidor: el dominio personalizado principal si existe; si no, el
subdomain
(null si la aplicación no tiene ninguno de los dos, es decir, no está publicada en la web). Construye los enlaces a partir de este campo,
nunca directamente desde subdomain: un despliegue autoalojado detrás de un edge no estándar puede devolver aquí otro host o esquema.string | null
La fecha y hora del último snapshot de la aplicación.
string
El archivo principal de la aplicación.
string
La versión del runtime (por ejemplo,
recommended o latest).string | null
El comando de inicio de la aplicación, si se ha especificado.
string | null
El comando de build, si se ha especificado. Se ejecuta después de instalar las dependencias y antes de que la aplicación arranque,
en un entorno de build aislado.
null cuando no hay ningún comando de build configurado.string | null
La fecha y hora desde la que la aplicación está fuera de línea, si aplica.
object | null
Aparece mientras Vertra Shield tiene la aplicación en pausa. Incluye
until (la hora en que termina el enfriamiento), reason (burst o rate_limit)
y direction (in o out); null cuando no hay ningún enfriamiento activo.object | null
El repositorio de GitHub vinculado (
repo_owner, repo_name) cuando el auto-deploy está conectado; null si la aplicación se creó desde un zip
o un snapshot. La URL del webhook no se incluye: para obtenerla, usa GET /v1/apps/{id}/deploys/webhook.object | null
La imagen Docker personalizada desde la que se ejecuta la aplicación;
null en una aplicación normal. Con una imagen, language, version, main_file, start_command
y build_command no aplican: vienen de la imagen. Consulta Imágenes Docker personalizadas.Mostrar Propiedades de custom_image
Mostrar Propiedades de custom_image
string
El ID de la imagen.
id y name de este objeto son los de la aplicación, no los de la imagen.integer | null
El puerto en el que escucha la aplicación y al que la plataforma enruta el tráfico;
null en una aplicación sin tráfico web.string | null
La versión de la imagen que ejecuta la aplicación, o
null si todavía no ha arrancado con ninguna versión.boolean
true cuando la imagen tiene una versión más reciente que la que ejecuta la aplicación. La aplicación pasará a ella en el siguiente reinicio o despliegue que pidas.object | null
Desde dónde se creó la aplicación, cuando se creó desde una plantilla, o
null en una aplicación normal.Mostrar Propiedades de template
Mostrar Propiedades de template
string
El ID de la plantilla.
string
El slug de la plantilla.
object
El nombre de la plantilla por idioma:
pt-br, y en y es cuando está traducida.string | null
La URL estable del icono de la plantilla, o
null para una plantilla privada sin icono o una plantilla que se ha eliminado.string
vertra, community o private.string
El ID de la versión con la que se creó la aplicación o a la que se actualizó por última vez.
string
El número de esa versión.
boolean
true cuando la plantilla está cerrada: el código de la aplicación no es accesible.boolean
true cuando la aplicación se desvinculó de la plantilla y ya no recibe versiones.boolean
true cuando la plantilla tiene una versión más reciente a la que la aplicación puede actualizarse.string | null
El número de la versión más reciente, o
null si no hay ninguna.boolean
true cuando el autor eliminó la plantilla; la aplicación sigue funcionando, pero ya no recibe actualizaciones.boolean
true cuando la aplicación se creó desde un enlace para compartir.string | null
El ID del servicio de la plantilla que es esta aplicación, o
null cuando la plantilla tiene un único servicio.object
Lo que la plantilla te permite hacer con esta aplicación:
code_view, code_edit, ram_change, ram_below_min, ram_above_max, env_add, commands_edit, terminal, save_as_template y detach, todos booleanos.string[]
Los ajustes de despliegue que la plantilla bloquea para esta aplicación:
zero_downtime y/o auto_rollback. Cambiarlos a otro valor en PATCH /v1/apps/:id/config devuelve 403 TEMPLATE_SETTING_LOCKED. Vacío cuando la aplicación está desvinculada.string | null
El ID del servicio de la plantilla que es esta aplicación dentro del stack, o
null si la añadiste tú mismo.object
Cómo un despliegue reemplaza la versión en ejecución y qué pasa si falla.
Mostrar Propiedades de deploy
Mostrar Propiedades de deploy
string
La opción guardada:
off (la predeterminada), auto u on. Cámbiala con Actualizar la configuración de la aplicación.boolean
Lo que se aplica al siguiente reinicio o despliegue:
true en Enterprise cuando zero_downtime es on, o cuando es auto y la aplicación recibe tráfico web.boolean
La opción guardada,
false por defecto. Devuelve el valor guardado en cualquier plan, pero solo surte efecto desde Intermediary.string | null
La ruta HTTP a la que se llama en una nueva versión para comprobar que está sana.
null significa /.string
La fecha y hora en que se creó la aplicación.
string
La fecha y hora de la última actualización de la aplicación.
{
"response": {
"id": "app-abc123def456",
"cluster": 1,
"type": 1,
"name": "API Simples",
"description": "I have a description :)",
"owner_id": "user-123456789012345678",
"owner_plan": "pro",
"language": "javascript",
"ram": 128,
"status": "up",
"subdomain": "myapp.vertraweb.app",
"domains": [],
"public_url": "https://myapp.vertraweb.app",
"last_snapshot": "2026-03-09T15:51:47.234Z",
"main_file": "index.js",
"version": "recommended",
"start_command": "node index.js",
"build_command": null,
"offline_since": null,
"shield_cooldown": null,
"github": null,
"custom_image": null,
"deploy": {
"zero_downtime": "off",
"zero_downtime_active": false,
"auto_rollback": false,
"health_check_path": null
},
"created_at": "2026-03-09T15:51:47.234Z",
"updated_at": "2026-03-20T15:06:41.449Z"
}
}
Respuestas de error
string
El código de error que indica el motivo del fallo. Valores posibles:
AUTH_TOKEN_MISSING,API_KEY_INVALID,SESSION_REVOKED: Falta la cabeceraAuthorization, la clave de API no es válida o la sesión del panel fue revocada (401).API_KEY_IP_DENIED,API_KEY_SCOPE_DENIED: La clave de API se usa desde una IP fuera de su lista de permitidas, o no tiene el scope que requiere la ruta (403).ACCESS_DENIED: El recurso pertenece a otra cuenta, o no tienes el permiso de workspace necesario para él (403).APP_NOT_FOUND: La aplicación indicada no existe.
string
Un mensaje descriptivo con más detalles sobre el error.
{
"code": "APP_NOT_FOUND"
}
{
"code": "ACCESS_DENIED"
}
Última modificación el 30 de octubre de 2026