Saltar al contenido principal
POST
Crear una conexión

Autorizaciones

Authorization
string
header
requerido

Token JWT de tipo bearer emitido por el proveedor de identidad.

Encabezados

X-Product-Name
string
requerido

Nombre del producto que se usa para aislar las conexiones.

Ejemplo:

"midaz"

Cuerpo

application/json

Configuración y credenciales de la conexión.

configName
string
requerido

Nombre único de configuración que se usa para hacer referencia a esta conexión.

Ejemplo:

"production-db"

databaseName
string
requerido

Nombre de la base de datos a la que se establece la conexión.

Ejemplo:

"mydatabase"

host
string
requerido

Nombre de host o dirección IP del servidor de base de datos.

Ejemplo:

"db.example.com"

password
string
requerido

Contraseña de autenticación de la base de datos.

Ejemplo:

"secretpassword"

port
integer<int64>
requerido

Puerto TCP del servidor de base de datos.

Ejemplo:

5432

type
string
requerido

Tipo de motor de base de datos.

Ejemplo:

"POSTGRESQL"

userName
string
requerido

Nombre de usuario para la autenticación en la base de datos.

Ejemplo:

"dbuser"

metadata
object

Metadatos opcionales de la conexión definidos por la aplicación.

Ejemplo:
schema
string

Esquema predeterminado opcional de la base de datos.

Ejemplo:

"public"

ssl
object

Configuración SSL/TLS opcional de la conexión.

Ejemplo:

Respuesta

Creado

configName
string
requerido

Nombre de configuración que se usa para hacer referencia a la conexión.

Ejemplo:

"production-db"

createdAt
string<date-time>
requerido

Fecha y hora de creación de la conexión.

Ejemplo:

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

databaseName
string
requerido

Nombre de la base de datos conectada.

Ejemplo:

"mydatabase"

host
string
requerido

Nombre de host o dirección IP del servidor de base de datos.

Ejemplo:

"db.example.com"

id
string
requerido

Identificador único de la conexión.

Ejemplo:

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

port
integer<int64>
requerido

Puerto TCP del servidor de base de datos.

Ejemplo:

5432

type
string
requerido

Tipo de motor de base de datos.

Ejemplo:

"POSTGRESQL"

updatedAt
string<date-time>
requerido

Fecha y hora de la última actualización de la conexión.

Ejemplo:

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

userName
string
requerido

Nombre de usuario para la autenticación en la base de datos.

Ejemplo:

"dbuser"

metadata
object

Metadatos de la conexión definidos por la aplicación.

Ejemplo:
productName
string

Producto propietario de la conexión.

Ejemplo:

"midaz"

schema
string

Esquema predeterminado de la base de datos, si está configurado.

Ejemplo:

"public"

ssl
object

Configuración SSL/TLS establecida, sin incluir los secretos.

Ejemplo: