SFTP Download Documentation

Version: 1.2.0 

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

SFTP Download

The module downloads the file specified by either the Remote File property or the sftpdownload.file on the incomming message. If the sftpdownload.file contains an array of files, all files will be downloaded.

Possible Errors

If a file or the download directory doesn't exist on the SFTP server the module will set an error on the message and a warning on the module. When input is an array of files, the module will download them one by one. If one file doesn't exist, the module will stop the download and set an error on the message and a warning on the module.

Settings

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

If the Remote File property is set, the module will download that file from the SFTP server. If it is left empty, the filename or an array of filenames, will be taken from the sftpdownload.file property on the incoming message.

Output

Output is the same as input

Examples

Download file from SFTP server by setting the module property

# Settings:
Host="localhost"
Port=22
Remote File="example.txt"
Download Directory="downloads"
Delete remote file after download=true

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

Download file from the SFTP server by taking the name from the incoming message.

# Settings:
Host="localhost"
Port=22
Remote File=""
Download Directory="downloads"
Delete remote file after download=true

# Incoming message:
  "sftpdownload": {
    "file": "myfile.txt"
  }

Download multiple files from the SFTP server by taking the name from the incoming message

# Settings:
Host="localhost"
Port=22
Remote File=""
Download Directory="downloads"
Delete remote file after download=true

# Incoming message:
  "sftpdownload": {
    "file": [
      "file1",
      "test/file2",
      "testdata/data/file3"
    ]
  }