Skip to content

Automatic translation — the Portuguese version is the reference. View in Portuguese

Updated on 2026-10-04

SFTP — connector

Reads CSV, JSON and XLSX files from a folder on your SFTP server (password or private key) and loads into the Bronze layer; Parquet is recognized and loaded directly.

On this page (15)

Read before: ../conectores.md (state map) and fichas.md (index of the sheets).


What it is#

Reads CSV, JSON and XLSX files from a folder on your SFTP server (password or private key) and loads into the Bronze layer; Parquet is recognized and loaded directly.

Supported ingestion modes:

  • We fetch — We fetch the data from your source.

What it's for#

Bring data from SFTP into your datalake and make it available to the Bronze/Silver/Gold layers, BI models and the natural language question wizard.

When to use / when not to use#

Use when you need to consolidate this source into the datalake on a scheduled basis, with isolation per workspace.

Remember that the first run with a real credential is followed by our team before the connector is fully released.

Plan and permissions#

  • Plan: core of the product (connectors are included in all plans; the limit is the number of sources in the plan).
  • Access: requires an active workspace — with the subscription overdue, suspended or canceled, the run is blocked.
  • Shutdown: the ingestion run can be temporarily turned off (maintenance or incident). When this happens, the screen informs that the feature is currently unavailable.

Prerequisites#

  • An SFTP account with access to the data you want to ingest.
  • Create (or use) an SFTP user with read-only permission on the folder containing the files and open network access to the server (port 22) for ingestia's IP. Provide host, port, user and the password OR the private key; the credential is encrypted and never shown again.

Credentials#

Authentication method: Username and password (or key and secret) using Basic authentication.

Sensitive fields. They are encrypted (AES-256-GCM) and never remain in the connection config, in the pipeline definition, in the export or in the DAG. By default the encrypted value is stored in the database; moving the credential of this connection to the external credentials vault is an explicit choice, done per connection after saving — see ../../administracao/credenciais-e-rotacao.md.

  • Password (senha) — Provide the password OR the private key below.
  • Private key (PEM/OpenSSH) (chavePrivada) — Alternative to password. If the key has a passphrase, enter it in the Password field.

Secrets are never re-shown and are redacted in every error/log (raw token, URL-encoded and in JSON).

Form fields#

FieldLabelTypeRequiredNote
hostHosttextyes—
portaPortnumbernodefault: 22
usuarioUsertextyes—
senha 🔒Passwordpassword/secretnosecret (encrypted; external vault optional); Provide the password OR the private key below.
chavePrivada 🔒Private key (PEM/OpenSSH)password/secretnosecret (encrypted; external vault optional); Alternative to password. If the key has a passphrase, enter it in the Password field.
pastaFoldertextnodefault: /; Each subfolder becomes a table; sibling files become partitions of the same table.

Step by step#

  1. In the menu Dados → Conexões, use Nova conexão.
  2. Choose SFTP from the catalog.
  3. Fill in the form fields (see the table above).
  4. Use Testar conexão. The result is split into three capabilities, each with OK, Failed, Not applicable or Not tested. In this sheet they mean: Network — the storage service endpoint is reachable from the application server; Authentication — the credential from the form (access key or service account, not user and password) was accepted; Read — it was possible to list the objects in the bucket/container under the specified prefix (the displayed count is of visible objects, not tables).
  5. Use Salvar conexão. Saving does NOT start any ingestion.
  6. On the connection card, use Montar extração (or go to Orquestração → Pipelines and use Conectar fonte). The pipeline points to the saved connection — the credential is not copied.
  7. In the review, Publicar (agenda desligada) creates version 1 without running anything. Afterwards, Ativar agenda and Executar agora are separate actions.

Example — connection test#

Example configuration (all values are fictitious; secrets appear masked):

text
# Exemplo sintético (valores fictícios — não são credenciais reais)
host = db.exemplo.invalid
porta = 22
usuario = <usuario>
senha = •••••• (cifrado — nunca exibido)
chavePrivada = •••••• (cifrado — nunca exibido)
pasta = /

Expected result#

The Testar conexão returns the number of visible objects under the specified prefix. After the first load, the contents of those files appear in the Bronze layer of your workspace, ready for the pipeline.

Limits and costs#

  • Pagination: hard cap per run (default 10,000 pages / 5,000,000 rows); anti-loop guard.
  • SaaS load: default batchSize 5,000, maxRows 200,000 per resource.
  • Estimated volume: ~2 GB/month (catalog estimate, not measurement).
  • Cost: the extraction itself is not charged by the platform; the Bronze load consumes datalake processing (billable).

Security#

  • Scope per workspace: each customer reads and writes only to their own datalake (<prefixo>_bronze / _silver / _gold); there is never leakage between workspaces.
  • Encrypted secrets: sensitive material is encrypted with AES-256-GCM before being stored. The external credentials vault is optional and enabled per connection; without it, the encrypted value remains in the database. Changing the value here DOES NOT revoke the credential at the source.
  • Redaction: all errors/logs go through secret redaction (raw, URL-encoded and in JSON).
  • Production doesn't fake it: a path that would fall into mock triggers the production guard (explicit failure instead of simulating success).

Common errors#

  • Authentication failed — the credential for this connector is NOT username and password: it's an access key (or service account). Check the pair provided in the form and whether it is still active at the provider.
  • Listing denied — the credential authenticates but cannot list the bucket. Grant bucket listing and read permission for objects under the prefix; read permission without listing is not enough, because the pipeline needs to discover which files exist.
  • Bucket/prefix does not exist or is empty — check the exact bucket name and the prefix (folder). A prefix with no objects returns zero visible objects, not an error.
  • File in unsupported format — object storage transports files; the pipeline needs to be able to read the content (CSV, JSON or Parquet). An object in another format is ignored or fails on load, according to the pipeline policy.

Troubleshooting#

  • Use Testar conexão to isolate credential/network issues before scheduling.
  • Monitor runs in observability by connector (error rate, p50/p95, freshness).
  • A schema change at the source is flagged by schema drift (new column = info; column removed/type changed = warning).

Related#


Last review: 2026-10-04. Sheet automatically generated from the product's connector catalog.

Related links