Skip to main content
POST
Create REST discovery connection

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json
configName
string
obrigatório

Unique connection config name (tenant-scoped)

Required string length: 1 - 255
Exemplo:

"pagbank-prod"

connectorType
enum<string>
obrigatório

REST connector type this connection serves

Opções disponíveis:
PAGBANK,
STRIPE,
PIX_BCB
Minimum string length: 1
Exemplo:

"PAGBANK"

apiKey
string

Stripe restricted API key

Maximum string length: 512
baseURL
string<uri>

Optional per-connection API base URL (http/https); when omitted the deployment default for the connector type is used

Maximum string length: 2048
Exemplo:

"https://sandbox.provider.example"

clientCert
string

PEM-encoded Pix client certificate

Maximum string length: 8192
clientID
string

Pix OAuth2 client id

Maximum string length: 512
clientKey
string

PEM-encoded Pix client private key

Maximum string length: 8192
clientSecret
string

Pix OAuth2 client secret

Maximum string length: 512
ediToken
string

PagBank EDI token

Maximum string length: 512
establishmentID
string

PagBank establishment id

Maximum string length: 512

Resposta

Created

configName
string
obrigatório

Connection configuration name

Exemplo:

"prod-ledger-db"

databaseName
string
obrigatório

Database name

Exemplo:

"ledger"

databaseType
string
obrigatório

Database engine type (canonical engine token as stored)

Exemplo:

"POSTGRESQL"

host
string
obrigatório

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

Exemplo:

"db.internal.example.com"

id
string
obrigatório

Internal Matcher connection identifier

Exemplo:

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

lastSeenAt
string<date-time>
obrigatório

Timestamp the connection was last observed healthy (RFC 3339)

Exemplo:

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

port
integer<int64>
obrigatório

Database port

Exemplo:

5432

schemaDiscovered
boolean
obrigatório

Whether table schemas have been discovered for this connection

status
string
obrigatório

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

Exemplo:

"available"

userName
string
obrigatório

Database user name the connection authenticates as

Exemplo:

"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

Exemplo:

"https://sandbox.provider.example"

schema
string

Schema/namespace within the database, when set

Exemplo:

"public"