SFTP

Supports:

  • ✅ Bulk sync source

Connection

Configuration

NameTypeDescriptionRequired
auth_modestringAuthentication Method

Accepted values: private_key , password
true
is_single_tablebooleanFiles are time-based snapshots

Treat the files as a single table.
false
pathstringPath

The path to the directory on the SFTP server containing the files.
false
skip_linesintegerSkip first lines

Skip first N lines of each CSV file.
false
ssh_hoststringHostfalse
ssh_portintegerPortfalse
ssh_userstringUserfalse

is_single_table

When is_single_table is true
NameTypeDescriptionRequired
single_table_namestringCollection namefalse

auth_mode

When auth_mode is password
NameTypeDescriptionRequired
ssh_passwordstringPasswordtrue
When auth_mode is private_key
NameTypeDescriptionRequired
ssh_private_keystringPrivate keytrue

Example

1{
2 "name": "SFTP connection",
3 "type": "sftp",
4 "configuration": {
5 "auth_mode": "private_key",
6 "is_single_table": false,
7 "path": "/path/to/files",
8 "skip_lines": 0,
9 "ssh_host": "sftp.example.net",
10 "ssh_port": 22,
11 "ssh_private_key": "",
12 "ssh_user": "user"
13 }
14}