v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Discovery

Create discovery connection

Provisions a Fetcher connection scoped to Matcher and synchronizes the local discovery cache.

post/v1/discovery/connections

Request body

configNamestring required

Connection configuration name

databaseNamestring required

Database name

databaseTypestring required

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

hoststring required

Database host

passwordstring

portinteger required

Database TCP port (1-65535)

schemastring

Optional schema/namespace within the database

userNamestring required

Database user name the connection authenticates as

Example request

{
  "configName": "prod-ledger-db",
  "databaseName": "ledger",
  "databaseType": "POSTGRESQL",
  "host": "db.internal.example.com",
  "port": 5432,
  "schema": "public",
  "userName": "matcher_ro"
}

Response

Created

idstring

Internal identifier for the connection

configNamestring

Name of the Fetcher configuration that produced this connection

databaseTypestring

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

statusstring

Current connection status

schemaDiscoveredboolean

Whether the table schema has been discovered for this connection

lastSeenAtstring

Timestamp when this connection was last observed in Fetcher