curl https://api.vertracloud.app/v1/template-deploys/3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63 \
-H "Authorization: Bearer $VERTRA_API_KEY"
{
"response": {
"id": "3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63",
"kind": "deploy",
"template_id": "7c1d4f0e-3b8a-4d52-9a66-1f0c2e5a9b41",
"version_id": "e0b7a2c9-5d14-4f8e-8c3a-92d6b1f47a10",
"version": "1.0.0",
"status": "succeeded",
"current_step": null,
"steps": [
{ "step": "validate", "status": "done", "started_at": "2026-10-28T14:00:01Z", "finished_at": "2026-10-28T14:00:02Z" },
{ "step": "apps", "status": "done", "started_at": "2026-10-28T14:00:02Z", "finished_at": "2026-10-28T14:00:20Z" },
{ "step": "variables", "status": "done", "started_at": "2026-10-28T14:00:20Z", "finished_at": "2026-10-28T14:00:21Z" },
{ "step": "start", "status": "done", "started_at": "2026-10-28T14:00:21Z", "finished_at": "2026-10-28T14:00:30Z" },
{ "step": "healthcheck", "status": "done", "started_at": "2026-10-28T14:00:30Z", "finished_at": "2026-10-28T14:00:41Z" },
{ "step": "outputs", "status": "done", "started_at": "2026-10-28T14:00:41Z", "finished_at": "2026-10-28T14:00:41Z" }
],
"error": null,
"resources": [
{ "resource_type": "application", "resource_id": "9d2c7e41-60fa-4b13-8e75-c1a4b3f08d26", "service_id": "app", "name": "my-discord-bot" }
],
"stack_id": null,
"application_id": "9d2c7e41-60fa-4b13-8e75-c1a4b3f08d26",
"outputs": [
{
"label": { "pt-br": "Próximo passo", "en": "Next step" },
"value": { "en": "Invite the bot to your server and type /ping." },
"secret": false,
"once": false
}
],
"created_at": "2026-10-28T14:00:00Z",
"updated_at": "2026-10-28T14:00:41Z",
"finished_at": "2026-10-28T14:00:41Z"
}
}
{
"response": {
"id": "3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63",
"kind": "deploy",
"template_id": "7c1d4f0e-3b8a-4d52-9a66-1f0c2e5a9b41",
"version_id": "e0b7a2c9-5d14-4f8e-8c3a-92d6b1f47a10",
"version": "1.0.0",
"status": "failed",
"current_step": null,
"steps": [
{ "step": "validate", "status": "done", "started_at": "2026-10-28T14:00:01Z", "finished_at": "2026-10-28T14:00:02Z" },
{ "step": "apps", "status": "failed", "started_at": "2026-10-28T14:00:02Z", "finished_at": "2026-10-28T14:00:50Z" },
{ "step": "variables", "status": "pending", "started_at": null, "finished_at": null }
],
"error": {
"code": "BUILD_FAILED",
"message": "An application of the template failed to build.",
"step": "apps"
},
"resources": [],
"stack_id": null,
"application_id": null,
"outputs": [],
"created_at": "2026-10-28T14:00:00Z",
"updated_at": "2026-10-28T14:01:05Z",
"finished_at": "2026-10-28T14:01:05Z"
}
}
Plantillas
Obtener trabajo de despliegue de plantilla
Devuelve el estado de un trabajo de despliegue o actualización de plantilla: pasos, recursos creados, error si falló y salidas al terminar.
GET
/
v1
/
template-deploys
/
{deploy_id}
curl https://api.vertracloud.app/v1/template-deploys/3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63 \
-H "Authorization: Bearer $VERTRA_API_KEY"
{
"response": {
"id": "3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63",
"kind": "deploy",
"template_id": "7c1d4f0e-3b8a-4d52-9a66-1f0c2e5a9b41",
"version_id": "e0b7a2c9-5d14-4f8e-8c3a-92d6b1f47a10",
"version": "1.0.0",
"status": "succeeded",
"current_step": null,
"steps": [
{ "step": "validate", "status": "done", "started_at": "2026-10-28T14:00:01Z", "finished_at": "2026-10-28T14:00:02Z" },
{ "step": "apps", "status": "done", "started_at": "2026-10-28T14:00:02Z", "finished_at": "2026-10-28T14:00:20Z" },
{ "step": "variables", "status": "done", "started_at": "2026-10-28T14:00:20Z", "finished_at": "2026-10-28T14:00:21Z" },
{ "step": "start", "status": "done", "started_at": "2026-10-28T14:00:21Z", "finished_at": "2026-10-28T14:00:30Z" },
{ "step": "healthcheck", "status": "done", "started_at": "2026-10-28T14:00:30Z", "finished_at": "2026-10-28T14:00:41Z" },
{ "step": "outputs", "status": "done", "started_at": "2026-10-28T14:00:41Z", "finished_at": "2026-10-28T14:00:41Z" }
],
"error": null,
"resources": [
{ "resource_type": "application", "resource_id": "9d2c7e41-60fa-4b13-8e75-c1a4b3f08d26", "service_id": "app", "name": "my-discord-bot" }
],
"stack_id": null,
"application_id": "9d2c7e41-60fa-4b13-8e75-c1a4b3f08d26",
"outputs": [
{
"label": { "pt-br": "Próximo passo", "en": "Next step" },
"value": { "en": "Invite the bot to your server and type /ping." },
"secret": false,
"once": false
}
],
"created_at": "2026-10-28T14:00:00Z",
"updated_at": "2026-10-28T14:00:41Z",
"finished_at": "2026-10-28T14:00:41Z"
}
}
{
"response": {
"id": "3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63",
"kind": "deploy",
"template_id": "7c1d4f0e-3b8a-4d52-9a66-1f0c2e5a9b41",
"version_id": "e0b7a2c9-5d14-4f8e-8c3a-92d6b1f47a10",
"version": "1.0.0",
"status": "failed",
"current_step": null,
"steps": [
{ "step": "validate", "status": "done", "started_at": "2026-10-28T14:00:01Z", "finished_at": "2026-10-28T14:00:02Z" },
{ "step": "apps", "status": "failed", "started_at": "2026-10-28T14:00:02Z", "finished_at": "2026-10-28T14:00:50Z" },
{ "step": "variables", "status": "pending", "started_at": null, "finished_at": null }
],
"error": {
"code": "BUILD_FAILED",
"message": "An application of the template failed to build.",
"step": "apps"
},
"resources": [],
"stack_id": null,
"application_id": null,
"outputs": [],
"created_at": "2026-10-28T14:00:00Z",
"updated_at": "2026-10-28T14:01:05Z",
"finished_at": "2026-10-28T14:01:05Z"
}
}
Devuelve un trabajo de despliegue o de actualización iniciado por Desplegar plantilla o Actualizar desde plantilla. Con una clave de API, el ámbito es
templates:deploy. Solo la cuenta que inició el trabajo puede leerlo; cualquier otro ID de trabajo responde TEMPLATE_DEPLOY_NOT_FOUND. La respuesta nunca se guarda en caché. Para ver el progreso en vivo sin hacer polling, usa el flujo de eventos.
string
requerido
El ID del trabajo, devuelto cuando el despliegue o la actualización fue aceptado.
Respuesta
object
El trabajo.
Mostrar Mostrar objeto
Mostrar Mostrar objeto
string
El ID del trabajo.
string
deploy cuando el trabajo creó recursos a partir de una plantilla; update cuando movió recursos existentes a una versión más nueva.string
El ID de la plantilla.
string
El ID de la versión que se despliega.
string
El número de la versión que se despliega.
string
queued, running, undoing (un paso falló y se está eliminando lo que creó el trabajo), succeeded o failed. Un trabajo failed ya deshizo todo lo que creó. succeeded y failed son estados finales.string | null
El paso que se ejecuta ahora, o
null cuando el trabajo está en cola o ya terminó.object[]
Los pasos que aplican al trabajo, en orden de ejecución. Cada uno tiene
step, status, started_at y finished_at (null hasta que ocurren). Un paso es pending, running, done, skipped (no aplica, por ejemplo cuando no hay base de datos) o failed. Pasos: validate, snapshot (solo en actualizaciones: un snapshot de seguridad antes de cambiar nada), network, databases, blob, images, apps, variables, certificates, start, healthcheck, outputs y rollback (solo en actualizaciones, cuando una actualización fallida vuelve al snapshot).object | null
Se define cuando
status es failed.Mostrar Mostrar objeto
Mostrar Mostrar objeto
string
Un código de error, como
TEMPLATE_DEPLOY_FAILED, BUILD_FAILED, MAX_APPS_REACHED o TEMPLATE_PLAN_REQUIRED.string
Una frase fija y legible, en inglés. Nunca incluye valores de tus variables.
string | null
El paso que falló.
object
Contexto opcional. En una actualización que no pudo volver al snapshot contiene
rollback_failed.object[]
Lo que creó el trabajo, en orden. Cada uno tiene
resource_type, resource_id, service_id (el servicio del manifiesto; null para el stack y las imágenes) y name. Queda vacío tras un fallo, porque el trabajo deshace lo que creó.string | null
El stack, cuando la plantilla tiene dos o más servicios.
string | null
La aplicación, cuando la plantilla tiene una sola aplicación.
object[]
Las salidas de un trabajo terminado con éxito; vacío antes de eso.
Mostrar Mostrar objeto
Mostrar Mostrar objeto
object
La etiqueta en los tres idiomas.
string | object | null
El valor: un texto, o un texto por idioma. En una salida con
once, el valor se devuelve solo en la primera lectura del trabajo terminado y después es null.boolean
true cuando el valor es un secreto.boolean
true cuando el valor se muestra una sola vez.string
Cuándo se aceptó el trabajo.
string
Cuándo cambió el trabajo por última vez.
string | null
Cuándo terminó el trabajo, o
null.curl https://api.vertracloud.app/v1/template-deploys/3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63 \
-H "Authorization: Bearer $VERTRA_API_KEY"
{
"response": {
"id": "3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63",
"kind": "deploy",
"template_id": "7c1d4f0e-3b8a-4d52-9a66-1f0c2e5a9b41",
"version_id": "e0b7a2c9-5d14-4f8e-8c3a-92d6b1f47a10",
"version": "1.0.0",
"status": "succeeded",
"current_step": null,
"steps": [
{ "step": "validate", "status": "done", "started_at": "2026-10-28T14:00:01Z", "finished_at": "2026-10-28T14:00:02Z" },
{ "step": "apps", "status": "done", "started_at": "2026-10-28T14:00:02Z", "finished_at": "2026-10-28T14:00:20Z" },
{ "step": "variables", "status": "done", "started_at": "2026-10-28T14:00:20Z", "finished_at": "2026-10-28T14:00:21Z" },
{ "step": "start", "status": "done", "started_at": "2026-10-28T14:00:21Z", "finished_at": "2026-10-28T14:00:30Z" },
{ "step": "healthcheck", "status": "done", "started_at": "2026-10-28T14:00:30Z", "finished_at": "2026-10-28T14:00:41Z" },
{ "step": "outputs", "status": "done", "started_at": "2026-10-28T14:00:41Z", "finished_at": "2026-10-28T14:00:41Z" }
],
"error": null,
"resources": [
{ "resource_type": "application", "resource_id": "9d2c7e41-60fa-4b13-8e75-c1a4b3f08d26", "service_id": "app", "name": "my-discord-bot" }
],
"stack_id": null,
"application_id": "9d2c7e41-60fa-4b13-8e75-c1a4b3f08d26",
"outputs": [
{
"label": { "pt-br": "Próximo passo", "en": "Next step" },
"value": { "en": "Invite the bot to your server and type /ping." },
"secret": false,
"once": false
}
],
"created_at": "2026-10-28T14:00:00Z",
"updated_at": "2026-10-28T14:00:41Z",
"finished_at": "2026-10-28T14:00:41Z"
}
}
{
"response": {
"id": "3f6a9c12-7e4b-4d58-a1c0-5b8e2d9f7a63",
"kind": "deploy",
"template_id": "7c1d4f0e-3b8a-4d52-9a66-1f0c2e5a9b41",
"version_id": "e0b7a2c9-5d14-4f8e-8c3a-92d6b1f47a10",
"version": "1.0.0",
"status": "failed",
"current_step": null,
"steps": [
{ "step": "validate", "status": "done", "started_at": "2026-10-28T14:00:01Z", "finished_at": "2026-10-28T14:00:02Z" },
{ "step": "apps", "status": "failed", "started_at": "2026-10-28T14:00:02Z", "finished_at": "2026-10-28T14:00:50Z" },
{ "step": "variables", "status": "pending", "started_at": null, "finished_at": null }
],
"error": {
"code": "BUILD_FAILED",
"message": "An application of the template failed to build.",
"step": "apps"
},
"resources": [],
"stack_id": null,
"application_id": null,
"outputs": [],
"created_at": "2026-10-28T14:00:00Z",
"updated_at": "2026-10-28T14:01:05Z",
"finished_at": "2026-10-28T14:01:05Z"
}
}
Respuestas de error
string
El código de error que indica el motivo del fallo. Valores posibles:
VALIDATION_ERROR:deploy_idno es un ID válido (400).API_KEY_SCOPE_DENIED: La clave de API no tiene el ámbitotemplates:deploy(403).TEMPLATE_DEPLOY_NOT_FOUND: El trabajo no existe o pertenece a otra cuenta (404).RATE_LIMIT_EXCEEDED: Demasiadas peticiones (429).INTERNAL_SERVER_ERROR: Fallo inesperado (500).
{
"code": "TEMPLATE_DEPLOY_NOT_FOUND"
}
Última modificación el 28 de octubre de 2026