Skip to main content
PATCH
Update a data source

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

dataSourceId
string
required

Unique data source identifier.

Body

application/json

JSON request payload.

configName
string

Updated stable business key; unique among live data sources.

Example:

"midaz_onboarding"

databaseName
string

Updated database name.

Example:

"onboarding"

host
string

Updated database host.

Example:

"db.internal"

metadata
object

Updated free-form metadata. Omit the member to leave the stored metadata unchanged; send an empty object to clear it.

options
string

Updated MongoDB URI options string. Not applicable to postgresql.

Example:

"authSource=admin"

password
string

Write-only credential; omitted means keep the stored credential.

Example:

"-"

port
integer<int64>

Updated database port.

Example:

5432

schemas
string[] | null

Updated PostgreSQL schemas to expose.

Example:
sslCaBase64
string

MongoDB or PostgreSQL: replace the Base64 PEM CA bundle; omit to preserve, empty string to clear. Requires password when changed.

Example:

""

sslMode
string

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

Example:

"require"

type
string

Updated engine type: postgresql or mongodb.

Example:

"postgresql"

username
string

Updated database username.

Example:

"reporter_ro"

Response

OK

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"