Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Discovery

Update discovery connection

Updates a Matcher-owned Fetcher connection and synchronizes the local discovery cache.

patch/v1/discovery/connections/{connectionId}

Path parameters

connectionIdstring uuid required

Matcher connection ID

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

Matcher connection ID

Request body

configNamestring

Connection configuration name

databaseNamestring

Database name

databaseTypestring

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

hoststring

Database host

passwordstring
portinteger

Database TCP port (1-65535)

schemastring

Optional schema/namespace within the database

userNamestring

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

OK

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