Skip to main content
POST
Create discovery connection

Autorizações

Authorization
string
header
obrigatório

Bearer token authentication (format: "Bearer {token}")

Corpo

application/json
configName
string
obrigatório

Connection configuration name

Minimum string length: 1
Exemplo:

"prod-ledger-db"

databaseName
string
obrigatório

Database name

Minimum string length: 1
Exemplo:

"ledger"

databaseType
string
obrigatório

Database engine type; canonical token or a common alias (e.g. postgres -> POSTGRESQL, mysql -> MYSQL)

Minimum string length: 1
Exemplo:

"POSTGRESQL"

host
string
obrigatório

Database host

Minimum string length: 1
Exemplo:

"db.internal.example.com"

port
integer<int64>
obrigatório

Database TCP port (1-65535)

Intervalo obrigatório: 1 <= x <= 65535
Exemplo:

5432

userName
string
obrigatório

Database user name the connection authenticates as

Minimum string length: 1
Exemplo:

"matcher_ro"

password
string
schema
string

Optional schema/namespace within the database

Exemplo:

"public"

Resposta

Created

A discovered Fetcher database connection

id
string

Internal identifier for the connection

configName
string

Name of the Fetcher configuration that produced this connection

databaseType
string

Type of database (e.g. postgres, mysql)

status
string

Current connection status

schemaDiscovered
boolean

Whether the table schema has been discovered for this connection

lastSeenAt
string

Timestamp when this connection was last observed in Fetcher