Pular para o conteúdo principal
GET
Consultar uma conexão

Autorizações

Authorization
string
header
obrigatório

Token JWT do tipo bearer emitido pelo provedor de identidade.

Parâmetros de caminho

id
string
obrigatório

Identificador do recurso.

Exemplo:

"2f1f35f4-4f50-44f3-a8ab-2772d395f0c2"

Resposta

OK

configName
string
obrigatório

Nome de configuração usado para referenciar a conexão.

Exemplo:

"production-db"

createdAt
string<date-time>
obrigatório

Data e hora em que a conexão foi criada.

Exemplo:

"2026-01-15T10:30:00Z"

databaseName
string
obrigatório

Nome do banco de dados conectado.

Exemplo:

"mydatabase"

host
string
obrigatório

Nome do host ou endereço IP do servidor de banco de dados.

Exemplo:

"db.example.com"

id
string
obrigatório

Identificador exclusivo da conexão.

Exemplo:

"018f47a6-3e5f-7b9a-8c1d-2e3f4a5b6c7d"

port
integer<int64>
obrigatório

Porta TCP do servidor de banco de dados.

Exemplo:

5432

type
string
obrigatório

Tipo do mecanismo de banco de dados.

Exemplo:

"POSTGRESQL"

updatedAt
string<date-time>
obrigatório

Data e hora da última atualização da conexão.

Exemplo:

"2026-01-16T14:45:00Z"

userName
string
obrigatório

Nome de usuário para autenticação no banco de dados.

Exemplo:

"dbuser"

metadata
object

Metadados da conexão definidos pela aplicação.

Exemplo:
productName
string

Produto proprietário da conexão.

Exemplo:

"midaz"

schema
string

Esquema padrão do banco de dados, quando configurado.

Exemplo:

"public"

ssl
object

Configurações de SSL/TLS definidas, sem os dados sigilosos.

Exemplo: