SFTP

Supports:

✅ Bulk sync source

Connection

Configuration

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

`auth_mode`

When auth_mode is private_key:

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

{
  "name": "SFTP connection",
  "type": "sftp",
  "configuration": {
    "auth_mode": "private_key",
    "is_single_table": false,
    "path": "/path/to/files",
    "skip_lines": 0,
    "ssh_host": "sftp.example.net",
    "ssh_port": 22,
    "ssh_private_key": "",
    "ssh_user": "user"
  }
}

When auth_mode is password:

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

{
  "name": "SFTP connection",
  "type": "sftp",
  "configuration": {
    "auth_mode": "password",
    "is_single_table": false,
    "path": "/path/to/files",
    "skip_lines": 0,
    "ssh_host": "sftp.example.net",
    "ssh_password": "",
    "ssh_port": 22,
    "ssh_user": "user"
  }
}

`is_single_table`

When is_single_table is true:

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

{
  "name": "SFTP connection",
  "type": "sftp",
  "configuration": {
    "auth_mode": "private_key",
    "is_single_table": true,
    "path": "/path/to/files",
    "single_table_name": "",
    "skip_lines": 0,
    "ssh_host": "sftp.example.net",
    "ssh_port": 22,
    "ssh_private_key": "",
    "ssh_user": "user"
  }
}

Bulk Sync

Source

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