Skip to main content
GET
Get a discovered connection

Authorizations

Authorization
string
header
required

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

Headers

X-Request-Id
string

A unique identifier for tracing the request across services.

Path Parameters

connectionId
string<uuid>
required

The unique identifier of the connection. Connection ID (UUID)

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Connection details

configName
string
required

Connection configuration name

Example:

"prod-ledger-db"

databaseName
string
required

Database name

Example:

"ledger"

databaseType
string
required

Database engine type (canonical engine token as stored)

Example:

"POSTGRESQL"

host
string
required

Database host; empty for REST connector connections, whose service address is reported as baseURL

Example:

"db.internal.example.com"

id
string
required

Internal Matcher connection identifier

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

lastSeenAt
string<date-time>
required

Timestamp the connection was last observed healthy (RFC 3339)

Example:

"2026-06-17T14:32:05Z"

port
integer<int64>
required

Database port

Example:

5432

schemaDiscovered
boolean
required

Whether table schemas have been discovered for this connection

status
string
required

Current lifecycle status of the connection as reported by the extraction engine

Example:

"available"

userName
string
required

Database user name the connection authenticates as

Example:

"matcher_ro"

baseURL
string<uri>

Per-connection API base URL of a REST connector connection; absent when the deployment default applies and for database connectors

Example:

"https://sandbox.provider.example"

schema
string

Schema/namespace within the database, when set

Example:

"public"