Detalhes da aplicação

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));

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

GET

apps

{id}

Detalhes da aplicação

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));

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

obrigatório

O ID da aplicação cujos detalhes serão retornados. Se a aplicação pertencer a um workspace, informe o ID dele no query parameter workspace_id.

string

Se a aplicação pertencer a um workspace, o ID do workspace. Obrigatório para membros do workspace que agem sobre uma aplicação que não lhes pertence.

Resposta

object

Os detalhes da aplicação.

Mostrar Mostrar objeto

string

O ID da aplicação.

integer

O ID do cluster da aplicação.

integer

O tipo da aplicação.

string

O nome da aplicação.

string

A descrição da aplicação.

string

O ID do dono da aplicação.

string | null

O nome do plano do dono (por exemplo, pro ou enterprise-8), ou null quando o dono não tem plano.

string

A linguagem de programação da aplicação (por exemplo, javascript).

integer

A RAM da aplicação, em MB.

string

O status da aplicação: up, down ou building (criação em andamento; a maioria das ações responde 409 APP_BUILDING).

string | null

O código da última falha de build ou de instalação, ou null após um build bem-sucedido. Um dos valores BUILD_FAILED, BUILD_TIMEOUT, BUILD_INTERRUPTED, INSTALL_FAILED, INSTALL_OUT_OF_MEMORY, INSTALL_TIMEOUT ou INSTALL_SHIELD_BLOCKED. O detalhe está nos logs da aplicação; veja em Erros o que fazer para cada código.

string | null

O subdomínio da aplicação, quando aplicável.

APIApplicationDomain[]

Os domínios personalizados da aplicação, com status, situação do SSL, porta, prefixo de caminho e redirecionamento. Vazio quando não há nenhum. Cada item está descrito em Listar domínios da aplicação.

string | null

A URL pública canônica da aplicação, já calculada pelo servidor: o domínio personalizado principal quando existe, caso contrário o subdomain (null quando a aplicação não tem nenhum dos dois, ou seja, não é publicada na web). Monte links a partir deste campo, nunca diretamente de subdomain — uma implantação self-hosted atrás de uma borda com configuração não padrão pode retornar outro host ou outro esquema aqui.

string | null

O timestamp do último snapshot da aplicação.

string

O arquivo principal da aplicação.

string

A versão do runtime (por exemplo, recommended ou latest).

string | null

O comando de inicialização da aplicação, se especificado.

string | null

O comando de build, se especificado. Roda após a instalação das dependências e antes de a aplicação iniciar, em um ambiente de build isolado. null quando nenhum comando de build está definido.

string | null

O timestamp desde quando a aplicação está offline, se aplicável.

object | null

Presente enquanto a Vertra Shield pausou a aplicação. Inclui until (o fim do cooldown), reason (burst ou rate_limit) e direction (in ou out); null quando nenhum cooldown está ativo.

object | null

O repositório GitHub vinculado (repo_owner, repo_name) quando o deploy automático está conectado; null quando a aplicação foi criada a partir de um zip ou de um snapshot. A URL do webhook não é incluída — use GET /v1/apps/{id}/deploys/webhook para obtê-la.

object | null

A imagem Docker personalizada da qual a aplicação roda; null para uma aplicação comum. Com uma imagem, language, version, main_file, start_command e build_command não se aplicam: eles vêm da imagem. Veja Imagens Docker personalizadas.

Mostrar Propriedades de custom_image

string

O ID da imagem. O id e o name deste objeto são os da aplicação, não os da imagem.

integer | null

A porta em que a aplicação escuta e para a qual a plataforma encaminha o tráfego; null para uma aplicação sem tráfego web.

string | null

A versão da imagem que a aplicação roda, ou null quando ela ainda não iniciou em nenhuma versão.

boolean

true quando a imagem tem uma versão mais nova do que a que a aplicação roda. Ela passa para a nova versão no próximo restart ou deploy que você pedir.

object | null

De onde veio a aplicação, quando ela foi criada a partir de um template, ou null para uma aplicação comum.

Mostrar Propriedades de template

string

O ID do template.

string

O slug do template.

object

O nome do template por idioma: pt-br, e en e es quando traduzido.

string | null

A URL estável do ícone do template, ou null para um template privado sem ícone ou para um template que foi removido.

string

vertra, community ou private.

string

O ID da versão a partir da qual a aplicação foi criada ou para a qual foi atualizada por último.

string

O número dessa versão.

boolean

true quando o template está fechado: o código da aplicação não fica acessível.

boolean

true quando a aplicação saiu do template e não recebe mais versões.

boolean

true quando o template tem uma versão mais nova para a qual a aplicação pode ser atualizada.

string | null

O número da versão mais nova, ou null quando não há nenhuma.

boolean

true quando o autor removeu o template; a aplicação continua rodando, mas não recebe mais atualizações.

true quando a aplicação foi criada a partir de um link de compartilhamento.

string | null

O ID do serviço do template que esta aplicação representa, ou null quando o template tem um único serviço.

object

O que o template permite fazer com esta aplicação: code_view, code_edit, ram_change, ram_below_min, ram_above_max, env_add, commands_edit, terminal, save_as_template e detach, todos booleanos.

string[]

As configurações de deploy que o template trava para esta aplicação: zero_downtime e/ou auto_rollback. Mudá-las para outro valor em PATCH /v1/apps/:id/config devolve 403 TEMPLATE_SETTING_LOCKED. Vazio quando a aplicação está desvinculada.

string | null

O ID da stack à qual a aplicação pertence, ou null quando ela não faz parte de uma stack.

string | null

O ID do serviço do template que esta aplicação representa dentro da stack, ou null quando você a adicionou por conta própria.

object

Como um deploy substitui a versão em execução e o que acontece se ele falhar.

Mostrar Propriedades de deploy

string

A opção salva: off (o padrão), auto ou on. Altere-a com Atualizar configuração da aplicação.

boolean

O que vale para o próximo restart ou deploy: true no Enterprise quando zero_downtime está em on, ou quando está em auto e a aplicação recebe tráfego web.

boolean

A opção salva, false por padrão. Ela devolve o valor salvo em qualquer plano, mas só passa a valer a partir do Intermediary.

string | null

O caminho HTTP chamado em uma nova versão para verificar se ela está saudável. null significa /.

string

O timestamp de quando a aplicação foi criada.

string

O timestamp de quando a aplicação foi atualizada pela última vez.

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

Respostas de erro

string

O código de erro que indica o motivo da falha. Valores possíveis:

AUTH_TOKEN_MISSING, API_KEY_INVALID, SESSION_REVOKED: o header Authorization está ausente, a chave de API é inválida ou a sessão do painel foi revogada (401).
API_KEY_IP_DENIED, API_KEY_SCOPE_DENIED: a chave de API é usada a partir de um IP fora da sua allowlist, ou não tem o escopo que a rota exige (403).
ACCESS_DENIED: o recurso pertence a outra conta, ou você não tem a permissão do workspace para ele (403).
APP_NOT_FOUND: a aplicação informada não existe.

string

Uma mensagem descritiva com detalhes adicionais sobre o erro.

{
  "code": "APP_NOT_FOUND"
}

{
  "code": "ACCESS_DENIED"
}

Última modificação em 30 de outubro de 2026

Visão geral

Endpoints

Detalhes da aplicação

Resposta

Respostas de erro

​Resposta

​Respostas de erro

Resposta

Respostas de erro