> ## 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 banco de dados pelo ID

> Retorna os detalhes de um banco de dados específico pelo seu ID.

**id** `string` *required*

O ID do banco de dados a obter. Se o banco de dados pertencer a um workspace, informe o ID dele no parâmetro de query `workspace_id`.

**workspace\_id** `string`

Se o banco de dados pertencer a um workspace, o ID do workspace. Obrigatório para membros do workspace que atuam sobre um banco de dados que não lhes pertence.

### Resposta

**response** `object`

Os detalhes do banco de dados.

**Mostrar objeto**

**id** `string`

O ID do banco de dados.

**cluster** `number`

O ID do cluster do banco de dados.

**type** `number`

O tipo do banco de dados.

**name** `string`

O nome do banco de dados.

**description** `string`

A descrição do banco de dados.

**owner\_id** `string`

O ID do dono do banco de dados.

**owner\_plan** `string | null`

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

**status** `string`

O status do banco de dados (por exemplo, `up`).

**ram** `number`

A RAM alocada ao banco de dados, em MB.

**host** `string`

O endereço do host do banco de dados.

**port** `number`

A porta usada pelo banco de dados.

**username** `string`

O usuário para conectar. Bancos de dados criados a partir da v26.4.8 usam `vertracloud` (banco padrão `vertracloud`, sem ser superusuário); bancos de dados mais antigos mantêm o usuário do motor (`postgres`, `default` ou `root`).

**version** `string`

A versão major do motor, por exemplo `"18"` ou `"8.0"`. Atualizações de segurança são aplicadas no restart sem alterá-la.

**stack\_id** `string | null`

O ID da [stack](https://docs.vertracloud.app/pt-br/api-reference/endpoint/stacks/get.md) à qual o banco de dados pertence, ou `null` quando ele não está em uma stack.

**stack\_service\_key** `string | null`

O ID do serviço do template em que este banco de dados está dentro da stack, ou `null` quando você o adicionou por conta própria.

**created\_at** `string`

A data e hora em que o banco de dados foi criado.

**updated\_at** `string`

A data e hora em que o banco de dados foi atualizado pela última vez.

**offline\_since** `string | null`

A data e hora em que o banco de dados ficou offline, se aplicável.

**last\_snapshot** `string | null`

A data e hora do último snapshot, se disponível.

```json Response theme={null}
{
  "response": {
    "id": "00000000000000000000000000000001",
    "cluster": 1,
    "type": 3,
    "name": "MyDatabase",
    "description": "I have a description :)",
    "owner_id": "123456789012345678",
    "owner_plan": "pro",
    "status": "up",
    "ram": 256,
    "host": "database.example.com",
    "port": 6379,
    "username": "vertracloud",
    "version": "8.2",
    "offline_since": null,
    "last_snapshot": "2026-03-14T19:58:00Z",
    "created_at": "2026-03-14T19:58:00Z",
    "updated_at": "2026-03-14T19:58:00Z"
  }
}
```

### 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 lista de IPs permitidos, 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 de workspace para ele (`403`).
* `DATABASE_NOT_FOUND`: O banco de dados informado não existe ou o usuário não tem acesso.

**message** `string`

Uma mensagem descritiva com detalhes adicionais sobre o erro.

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

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


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