SFTP

Supports:

✅ Bulk sync source

Connection

Configuration

Name	Type	Description	Required
`auth_mode`	`string`	Authentication Method Accepted values: `private_key` ↓, `password` ↓	`true`
`is_single_table`	`boolean`	Files are time-based snapshots Treat the files as a single table. ↓	`false`
`path`	`string`	Path The path to the directory on the SFTP server containing the files.	`false`
`skip_lines`	`integer`	Skip first lines Skip first N lines of each CSV file.	`false`
`ssh_host`	`string`	Host	`false`
`ssh_port`	`integer`	Port	`false`
`ssh_user`	`string`	User	`false`

`is_single_table`

When `is_single_table` is `true`

Name	Type	Description	Required
`single_table_name`	`string`	Collection name	`false`

`auth_mode`

When `auth_mode` is `password`

Name	Type	Description	Required
`ssh_password`	`string`	Password	`true`

When `auth_mode` is `private_key`

Name	Type	Description	Required
`ssh_private_key`	`string`	Private key	`true`

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 }

Bulk Sync

Source

SFTP connections may be used as a bulk sync source. No additional configuration options are required.

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	}

Connection

Configuration

is_single_table

When is_single_table is true

auth_mode

When auth_mode is password

When auth_mode is private_key

Example

Bulk Sync

Source

Connection

Configuration

is_single_table

When is_single_table is true

auth_mode

When auth_mode is password

When auth_mode is private_key

Example

Bulk Sync

Source

`is_single_table`

When `is_single_table` is `true`

`auth_mode`

When `auth_mode` is `password`

When `auth_mode` is `private_key`

`is_single_table`

When `is_single_table` is `true`

`auth_mode`

When `auth_mode` is `password`

When `auth_mode` is `private_key`