Update a data source
Partially updates a data source. An omitted password preserves the stored credential; a present password is re-encrypted. Renaming configName revokes the previous name exactly as a delete does: the previous name is free for a new data source to claim, but until one does, anything still referencing it fails instead of resolving against a different database.
Authorizations
JWT bearer token issued by the identity provider.
Path Parameters
Unique data source identifier.
Body
JSON request payload.
Updated stable business key; unique among live data sources.
"midaz_onboarding"
Updated database name.
"onboarding"
Updated database host.
"db.internal"
Updated free-form metadata. Omit the member to leave the stored metadata unchanged; send an empty object to clear it.
Updated MongoDB URI options string. Not applicable to postgresql.
"authSource=admin"
Write-only credential; omitted means keep the stored credential.
"-"
Updated database port.
5432
Updated PostgreSQL schemas to expose.
MongoDB or PostgreSQL: replace the Base64 PEM CA bundle; omit to preserve, empty string to clear. Requires password when changed.
""
Updated TLS mode: disable, require, verify-ca, or verify-full.
"require"
Updated engine type: postgresql or mongodb.
"postgresql"
Updated database username.
"reporter_ro"
Response
OK
True for a data source the platform provides from the tenant's Lerian module databases; read-only, never registered
false
Stable business key referenced by templates
"midaz_onboarding"
Creation timestamp in UTC
"2026-01-01T00:00:00Z"
Database name
"onboarding"
Database host
"db.internal"
Unique data source identifier
"00000000-0000-0000-0000-000000000000"
Outcome of the most recent connectivity probe; absent means never probed, which is not the same as failed
Free-form metadata
MongoDB URI options string (e.g. authSource=admin); mongodb only
"authSource=admin"
Database port
5432
PostgreSQL schemas to expose
Base64-encoded PEM CA bundle for MongoDB or PostgreSQL; never a private key. PostgreSQL requires sslMode verify-ca or verify-full.
""
TLS mode: disable, require, verify-ca, or verify-full
"require"
Data source engine type
"postgresql"
Most recent update timestamp in UTC
"2026-01-01T00:00:00Z"
Database username
"reporter_ro"

