SFTP Directory Reader Documentation

Version: 1.1.0

Retrieved: 2025-10-09 15:16:18

SFTP Directory Reader

The module reads the files of a remote directory from an SFTP server and passes the result (Array) to the next module(s) in the flow.

Settings

Name Requirements Purpose Default
Host String with length 1-128 The SFTP server to use localhost
Port Number between 1 and 65535 The port to use 22
Remote Directory String with length 0-256 The Remote Directory to use, if left empty the value will be taken from 'sftpdirectoryreader.directory' on the incomming message  
Target Property String with length 1-64 Property that the file names will be written to data
Include Sub Folders Bool If set, directories will also be included in the result false

Credential

This module contains an option to select credentials to use in the module. All credentials supported by the module are presented in a drop-down.

Input

Any message.

Output

The same as the input, but the output will also have the contents of the text file added at Target Property and also the 'crosser' object added.

Example - Read Text File from SFTP server

# Settings:
Host="localhost"
Port=22
Remote Directory="upload"
Filename="example.txt"
Target Property="data"

# Incoming message:
{
    "SomeKey": "SomeValue"
}

# Outgoing message:
{
    "SomeKey": "SomeValue",
    "data": ["file1.txt", "file2.zip"]
}

Search Documentation

Data Sources

Files