Read File (SFTP)
Overview
The Read File (SFTP) node downloads one or more files from a remote server over SFTP and outputs them as NodeFile values.
Purpose
Use this node when a workflow needs files from a remote server over an encrypted SSH File Transfer Protocol connection.
Configuration
| Field | Description |
|---|---|
| SSH Service | SSH service configuration that holds the host, port, credentials, and SFTP settings for the target server. For more, see SSH Service. |
| Remote file path | Exact remote path or wildcard pattern, including the file name or pattern. Workflow properties can be used in the path. |
Outputs
| Output | Data Type | Collection | Description |
|---|---|---|---|
| NodeFile | NodeFile | True | One output item for each matching remote file. |
Processing Logic
At runtime, the node evaluates expressions in the configured remote path. If the path is exact, it resolves and downloads that file. If the path contains a wildcard or directory pattern, it lists the matching remote folder entries, skips directories, downloads matching files into the workflow working directory, attaches metadata properties, and emits each file as a NodeFile. If the path is blank or no matching files are found, the node emits an empty output.
Examples
/reports/2024/invoice.pdf
/inbound/invoice_*.csv
Notes / Limitations
- The file is read using the secure SFTP protocol over an encrypted SSH channel.
- The remote path must include a file name or wildcard pattern.
- Directories are ignored.
- If no files match, the node returns an empty output rather than failing.
- Use workflow properties in the path to dynamically resolve the file location at runtime.