> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vertracloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Status da aplicação

> Retorna o status atual e o uso de recursos de uma aplicação pelo seu ID.

**id** `string` *required*

O ID da aplicação cujo status será retornado. Se a aplicação pertencer a um workspace, informe o ID dele no query parameter `workspace_id`.

**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.

> [!NOTE]
>
> **Uma aplicação parada responde `200`, e não um erro.** O container de uma aplicação parada não existe — ele é removido ao parar — e isso é um estado normal, não uma falha. A API retorna `200` com `running: false` e todas as métricas zeradas. Só uma falha real na leitura do status retorna `500`.

### Resposta

**response** `object`

O status da aplicação e os detalhes de uso de recursos.

**Mostrar objeto**

**id** `string`

O ID da aplicação.

**cpu** `string`

Porcentagem de uso de CPU (por exemplo, `25.5%`).

**ram** `string`

Uso de RAM (por exemplo, `512 MB`).

**storage** `string`

Uso de armazenamento (por exemplo, `1024 MB`).

**status** `string`

O status da aplicação (por exemplo, `running`).

**running** `boolean`

Indica se a aplicação está em execução.

**installing** `boolean`

Presente e `true` enquanto as dependências estão sendo instaladas ou a aplicação está sendo rebuildada. Durante esse tempo, `running` pode ser `false` mesmo com trabalho em andamento. Trate isso como um estado em progresso, não como "parada", e não emita um start enquanto ele for `true`. Um [restart](https://docs.vertracloud.app/pt-br/api-reference/endpoint/apps/restart.md) com `reinstall_dependencies` ou `force_build` é uma das operações que abrem esta janela.

**network** `object`

Detalhes de uso de rede.

**Mostrar objeto**

**total** `string`

Tráfego de rede total.

**now** `string`

Tráfego de rede atual.

**uptime** `number`

O tempo em que a aplicação está no ar, em segundos.

```json Response theme={null}
{
  "response": {
    "id": "app-abc123def456",
    "cpu": "25.50%",
    "ram": "512.00 MB",
    "storage": "1024.00 MB",
    "status": "running",
    "running": true,
    "network": {
      "total": "569.90KB ↓ 36.41KB ↑",
      "now": "18.78KB ↑ 1.20KB ↓"
    },
    "uptime": 3600
  }
}
```

### Respostas de erro

**code** `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.
* `FORBIDDEN`: o usuário não tem permissão para acessar a aplicação.
* `INTERNAL_SERVER_ERROR`: o status não pôde ser lido. Uma aplicação parada **não** é este caso — veja a nota acima.

**message** `string`

Uma mensagem descritiva com detalhes adicionais sobre o erro.

```json Error Response (404) theme={null}
{
  "code": "APP_NOT_FOUND"
}
```

```json Error Response (403) theme={null}
{
  "code": "FORBIDDEN"
}
```

```json Error Response (500) theme={null}
{
  "code": "INTERNAL_SERVER_ERROR"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.