Saltar al contenido principal
POST
/
v1
/
discovery
/
connections
Crear conexión de descubrimiento
curl --request POST \
  --url https://matcher.sandbox.lerian.net/v1/discovery/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "configName": "<string>",
  "databaseName": "<string>",
  "databaseType": "<string>",
  "host": "<string>",
  "port": 32768,
  "userName": "<string>",
  "password": "<string>",
  "schema": "<string>"
}
'
{
  "id": "<string>",
  "configName": "<string>",
  "databaseType": "<string>",
  "status": "<string>",
  "schemaDiscovered": true,
  "lastSeenAt": "<string>"
}

Autorizaciones

Authorization
string
header
requerido

Autenticación con token Bearer (formato: "Bearer {token}")

Cuerpo

application/json
configName
string
requerido

Nombre de la configuración de conexión

Minimum string length: 1
Ejemplo:

"prod-ledger-db"

databaseName
string
requerido

Nombre de la base de datos

Minimum string length: 1
Ejemplo:

"ledger"

databaseType
string
requerido

Tipo de motor de base de datos; token canónico o un alias común (p. ej. postgres -> POSTGRESQL, mysql -> MYSQL)

Minimum string length: 1
Ejemplo:

"POSTGRESQL"

host
string
requerido

Host de la base de datos

Minimum string length: 1
Ejemplo:

"db.internal.example.com"

port
integer<int64>
requerido

Puerto TCP de la base de datos (1-65535)

Rango requerido: 1 <= x <= 65535
Ejemplo:

5432

userName
string
requerido

Nombre de usuario de base de datos con el que se autentica la conexión

Minimum string length: 1
Ejemplo:

"matcher_ro"

password
string
schema
string

Esquema/espacio de nombres opcional dentro de la base de datos

Ejemplo:

"public"

Respuesta

Creado

Una conexión de base de datos de Fetcher descubierta

id
string

Identificador interno de la conexión

configName
string

Nombre de la configuración de Fetcher que generó esta conexión

databaseType
string

Tipo de base de datos (p. ej., postgres, mysql)

status
string

Estado actual de la conexión

schemaDiscovered
boolean

Indica si el esquema de tablas ha sido descubierto para esta conexión

lastSeenAt
string

Marca de tiempo en que se observó esta conexión por última vez en Fetcher