Skip to main content
POST
Disparar uma busca-e-ingestão manual de um transporte externo

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

contextId
string<uuid>
obrigatório

Context ID ID do contexto

sourceId
string<uuid>
obrigatório

Source ID ID da origem

Corpo

application/json
credentialRef
string
obrigatório

Referência opaca de credencial armazenada (não é um segredo)

Minimum string length: 1
Exemplo:

"cred-handle-123"

host
string
obrigatório

Hostname ou IP do endpoint remoto

Minimum string length: 1
Exemplo:

"sftp.bank.example"

path
string
obrigatório

Diretório remoto para listar/obter

Minimum string length: 1
Exemplo:

"outbound/returns"

port
integer<int64>
obrigatório

Porta do endpoint remoto

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

22

connectOptions
object

Ajuste de transporte não secreto opcional (ex.: known_hosts, user, timeout_seconds)

format
string

Dica de formato de conteúdo de fallback aplicada quando um objeto obtido não declara nenhum. Aceita a chave de FormatDescriptor com namespace (região/família/variante) ou os aliases planos legados (cnab240, cielo_edi, ...); ambos resolvem pelo mesmo registro de parser

Exemplo:

"br/cnab240/febraban-base"

glob
string

Filtro glob opcional; vazio obtém todos

Exemplo:

"*.ret"

kind
enum<string>

Tipo de transporte que seleciona o adaptador

Opções disponíveis:
sftp,
https,
s3,
imap
Exemplo:

"sftp"

Resposta

Aceito

files
object[] | null
obrigatório

Resultados por arquivo do lote de busca-e-ingestão, na ordem de busca