Pular para o conteúdo principal
GET
Get a data source

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

dataSourceId
string
obrigatório

Unique data source identifier.

Resposta

OK

builtIn
boolean

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

Exemplo:

false

configName
string

Stable business key referenced by templates

Exemplo:

"midaz_onboarding"

createdAt
string<date-time>

Creation timestamp in UTC

Exemplo:

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

databaseName
string

Database name

Exemplo:

"onboarding"

host
string

Database host

Exemplo:

"db.internal"

id
string

Unique data source identifier

Exemplo:

"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

Exemplo:

"authSource=admin"

port
integer<int64>

Database port

Exemplo:

5432

schemas
string[] | null

PostgreSQL schemas to expose

Exemplo:
sslCaBase64
string

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

Exemplo:

""

sslMode
string

TLS mode: disable, require, verify-ca, or verify-full. The two engines read require differently: MongoDB's driver verifies the server certificate under require (verify-full in effect), PostgreSQL's encrypts without verifying it; verify-full means the same on both.

Exemplo:

"require"

type
string

Data source engine type

Exemplo:

"postgresql"

updatedAt
string<date-time>

Most recent update timestamp in UTC

Exemplo:

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

username
string

Database username

Exemplo:

"reporter_ro"