Pular para o conteúdo principal
POST
/
v1
/
discovery
/
connections
Criar conexão de descoberta
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>"
}

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Corpo

application/json
configName
string
obrigatório

Nome da configuração da conexão

Minimum string length: 1
Exemplo:

"prod-ledger-db"

databaseName
string
obrigatório

Nome do banco de dados

Minimum string length: 1
Exemplo:

"ledger"

databaseType
string
obrigatório

Tipo de engine de banco de dados; token canônico ou um alias comum (ex.: postgres -> POSTGRESQL, mysql -> MYSQL)

Minimum string length: 1
Exemplo:

"POSTGRESQL"

host
string
obrigatório

Host do banco de dados

Minimum string length: 1
Exemplo:

"db.internal.example.com"

port
integer<int64>
obrigatório

Porta TCP do banco de dados (1-65535)

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

5432

userName
string
obrigatório

Nome de usuário do banco de dados com o qual a conexão se autentica

Minimum string length: 1
Exemplo:

"matcher_ro"

password
string
schema
string

Schema/namespace opcional dentro do banco de dados

Exemplo:

"public"

Resposta

Criado

Uma conexão de banco de dados do Fetcher descoberta

id
string

Identificador interno da conexão

configName
string

Nome da configuração do Fetcher que gerou esta conexão

databaseType
string

Tipo de banco de dados (ex.: postgres, mysql)

status
string

Status atual da conexão

schemaDiscovered
boolean

Indica se o esquema de tabela foi descoberto para esta conexão

lastSeenAt
string

Timestamp em que esta conexão foi observada pela última vez no Fetcher