Create connection
Creates a database connection for the product named by the X-Product-Name header.
Authorizations
JWT bearer token issued by the identity provider.
Headers
Product name used for connection isolation.
"midaz"
Body
Connection settings and credentials.
Unique configuration name used to reference this connection.
"production-db"
Database name to connect to.
"mydatabase"
Database server hostname or IP address.
"db.example.com"
Database authentication password.
"secretpassword"
Database server TCP port.
5432
Database engine type.
"POSTGRESQL"
Database authentication username.
"dbuser"
Optional application-defined connection metadata.
Optional default database schema.
"public"
Optional SSL/TLS connection settings.
Response
Created
Configuration name used to reference the connection.
"production-db"
Timestamp when the connection was created.
"2026-01-15T10:30:00Z"
Connected database name.
"mydatabase"
Database server hostname or IP address.
"db.example.com"
Unique connection identifier.
"018f47a6-3e5f-7b9a-8c1d-2e3f4a5b6c7d"
Database server TCP port.
5432
Database engine type.
"POSTGRESQL"
Timestamp when the connection was last updated.
"2026-01-16T14:45:00Z"
Database authentication username.
"dbuser"
Application-defined connection metadata.
Product that owns the connection.
"midaz"
Default database schema, when configured.
"public"
Configured SSL/TLS settings with secrets omitted.

