Skip to main content
POST
Create a data source

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json

JSON request payload.

configName
string
required

Stable business key referenced by templates; unique among live data sources.

Example:

"midaz_onboarding"

databaseName
string
required

Database name.

Example:

"onboarding"

host
string
required

Database host.

Example:

"db.internal"

password
string
required

Write-only credential: encrypted at rest, never returned by any operation.

Example:

"-"

port
integer<int64>
required

Database port.

Example:

5432

type
string
required

Data source engine type: postgresql or mongodb.

Example:

"postgresql"

username
string
required

Database username.

Example:

"reporter_ro"

metadata
object

Free-form metadata.

options
string

MongoDB URI options string (e.g. authSource=admin). Not applicable to postgresql.

Example:

"authSource=admin"

schemas
string[] | null

PostgreSQL schemas to expose; defaults to [public]. Not applicable to mongodb.

Example:
sslCaBase64
string

MongoDB or PostgreSQL: standard Base64 of a PEM CA bundle. Mutually exclusive with an existing CA file; requires verified TLS (postgresql requires sslMode verify-ca or verify-full).

Example:

""

sslMode
string

TLS mode: disable, require, verify-ca, or verify-full. Defaults to verify-full for PostgreSQL with sslCaBase64; otherwise defaults to require when omitted.

Example:

"require"

Response

Created

builtIn
boolean

True for a data source the platform provides from the tenant's Lerian module databases; read-only, never registered

Example:

false

configName
string

Stable business key referenced by templates

Example:

"midaz_onboarding"

createdAt
string<date-time>

Creation timestamp in UTC

Example:

"2026-01-01T00:00:00Z"

databaseName
string

Database name

Example:

"onboarding"

host
string

Database host

Example:

"db.internal"

id
string

Unique data source identifier

Example:

"00000000-0000-0000-0000-000000000000"

lastConnection
object

Outcome of the most recent connectivity probe; absent means never probed, which is not the same as failed

metadata
object

Free-form metadata

options
string

MongoDB URI options string (e.g. authSource=admin); mongodb only

Example:

"authSource=admin"

port
integer<int64>

Database port

Example:

5432

schemas
string[] | null

PostgreSQL schemas to expose

Example:
sslCaBase64
string

Base64-encoded PEM CA bundle for MongoDB or PostgreSQL; never a private key. PostgreSQL requires sslMode verify-ca or verify-full.

Example:

""

sslMode
string

TLS mode: disable, require, verify-ca, or verify-full

Example:

"require"

type
string

Data source engine type

Example:

"postgresql"

updatedAt
string<date-time>

Most recent update timestamp in UTC

Example:

"2026-01-01T00:00:00Z"

username
string

Database username

Example:

"reporter_ro"