Skip to main content
POST
Create connection

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Product-Name
string
required

Product name used for connection isolation.

Example:

"midaz"

Body

application/json

Connection settings and credentials.

configName
string
required

Unique configuration name used to reference this connection.

Example:

"production-db"

databaseName
string
required

Database name to connect to.

Example:

"mydatabase"

host
string
required

Database server hostname or IP address.

Example:

"db.example.com"

password
string
required

Database authentication password.

Example:

"secretpassword"

port
integer<int64>
required

Database server TCP port.

Example:

5432

type
string
required

Database engine type.

Example:

"POSTGRESQL"

userName
string
required

Database authentication username.

Example:

"dbuser"

metadata
object

Optional application-defined connection metadata.

Example:
schema
string

Optional default database schema.

Example:

"public"

ssl
object

Optional SSL/TLS connection settings.

Example:

Response

Created

configName
string
required

Configuration name used to reference the connection.

Example:

"production-db"

createdAt
string<date-time>
required

Timestamp when the connection was created.

Example:

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

databaseName
string
required

Connected database name.

Example:

"mydatabase"

host
string
required

Database server hostname or IP address.

Example:

"db.example.com"

id
string
required

Unique connection identifier.

Example:

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

port
integer<int64>
required

Database server TCP port.

Example:

5432

type
string
required

Database engine type.

Example:

"POSTGRESQL"

updatedAt
string<date-time>
required

Timestamp when the connection was last updated.

Example:

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

userName
string
required

Database authentication username.

Example:

"dbuser"

metadata
object

Application-defined connection metadata.

Example:
productName
string

Product that owns the connection.

Example:

"midaz"

schema
string

Default database schema, when configured.

Example:

"public"

ssl
object

Configured SSL/TLS settings with secrets omitted.

Example: