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

# Obter stack

> Retorna uma stack com os membros, o status, as conexões, o total de memória e o template de onde ela veio.

Retorna uma stack e tudo o que há nela: apps, bancos de dados e pastas do Blob, as conexões entre eles, o status dos membros somado e, quando a stack veio de um template, o template e a versão. Precisa do escopo `stacks:read` quando chamado com uma chave de API.

**stack\_id** `string` *required*

O ID da stack.

**workspace\_id** `string`

O workspace ao qual a stack pertence. Obrigatório para um membro do workspace que age sobre uma stack que não é dele; o dono pode omitir.

### Resposta

**response** `object`

A stack.

**Mostrar objeto**

**id** `string`

O ID da stack.

**name** `string`

O nome da stack.

**description** `string | null`

Descrição opcional, ou `null`.

**network\_mode** `string`

Como os membros se alcançam. O valor é `public`: os serviços usam os endereços públicos e os bancos de dados são acessados com certificados de cliente.

**owner\_id** `string`

A conta que é dona da stack.

**workspace\_id** `string | null`

O workspace ao qual a stack pertence, ou `null` quando ela é sua.

**members** `object[]`

Os membros. Cada um tem `resource_type` (`application`, `database` ou `blob`), `resource_id`, `name`, `status` (`null` para uma pasta do Blob), `ram` em MB (`0` para uma pasta do Blob), `service_key` (o ID do serviço no template, `null` para um membro que você adicionou), `database_type` (o engine de um banco de dados, senão `null`), `closed` (`true` para um app de um [template fechado](https://docs.vertracloud.app/pt-br/templates/use/closed-templates.md): o código dele não é acessível) e `blob`.

Para um membro Blob, `blob` tem o `prefix` da pasta, `visibility` (`private` ou `public`), `used_bytes` (ou `null`) e `api_key_id`, a chave que a plataforma criou para a stack e restringiu a essa pasta. Veja [Adicionar pasta do Blob à stack](https://docs.vertracloud.app/pt-br/api-reference/endpoint/stacks/blob/create.md).

**status** `object`

Membros online, offline e em build, somados: `up`, `down`, `building` e `total` (os membros que têm um status).

**ram\_total** `integer`

Memória de todos os membros, em MB.

**bindings** `object[]`

As conexões entre os membros. Cada uma tem `id`, `stack_id`, `app_id` (o app que recebe as variáveis), exatamente um entre `database_id`, `blob_id` e `target_app_id`, `env_map` (nome da variável para o que ela recebe), `certs_path` (a pasta dentro do app onde são gravados os certificados de cliente de um banco, `null` sem banco de dados) e `created_at`. Veja [Criar conexão da stack](https://docs.vertracloud.app/pt-br/api-reference/endpoint/stacks/bindings/create.md).

**template** `object | null`

O template e a versão de onde a stack veio, ou `null` para uma stack montada à mão. Tem os mesmos campos do `template` de um [app](https://docs.vertracloud.app/pt-br/api-reference/endpoint/apps/get.md), incluindo `icon_url`, a URL estável do ícone do template (`null` quando não há um).

**update\_available** `boolean`

`true` quando o template tem uma versão mais nova para a qual a stack pode atualizar.

**created\_at** `string`

Quando a stack foi criada.

**updated\_at** `string`

Quando a stack foi atualizada pela última vez.

```json Response theme={null}
{
  "response": {
    "id": "stk-abc123def456",
    "name": "shop",
    "description": null,
    "network_mode": "public",
    "owner_id": "usr-abc123",
    "workspace_id": null,
    "members": [
      { "resource_type": "application", "resource_id": "app-abc123def456", "name": "web", "status": "up", "ram": 512, "service_key": null, "database_type": null, "closed": false, "blob": null },
      { "resource_type": "database", "resource_id": "db-abc123def456", "name": "main", "status": "up", "ram": 256, "service_key": null, "database_type": "postgres", "closed": false, "blob": null }
    ],
    "status": { "up": 2, "down": 0, "building": 0, "total": 2 },
    "ram_total": 768,
    "bindings": [
      {
        "id": "bnd-abc123def456",
        "stack_id": "stk-abc123def456",
        "app_id": "app-abc123def456",
        "database_id": "db-abc123def456",
        "blob_id": null,
        "target_app_id": null,
        "env_map": { "DATABASE_URL": "url" },
        "certs_path": "/app/.vertra/certs/db-abc123def456/",
        "created_at": "2026-10-27T12:00:00.000Z"
      }
    ],
    "template": null,
    "update_available": false,
    "created_at": "2026-10-27T12:00:00.000Z",
    "updated_at": "2026-10-27T12:00:00.000Z"
  }
}
```

### Erros

| Status | Código | Quando |
| - | - | - |
| 403 | `API_KEY_SCOPE_DENIED` | A chave não tem `stacks:read`. |
| 404 | `STACK_NOT_FOUND` | A stack não existe ou pertence a outra conta. |


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