SFTP Module

The SFTP module allows interaction with directories and files on a SFTP server.

SFTP module functions

directoryExists

Signature: (path: text) -> boolean.

Determines whether a directory exists at the specified path.

Output: Returns True if the directory exists, False otherwise.

//path to the directory
let path = @"/upload";

return SFTP.directoryExists(path);

//The path parameter can be passed as inline value as well.
return SFTP.directoryExists(@"/upload");

createDirectory

Signature: (path: text)

Creates a directory at the SFTP server. It is not possible to create several levels of directories in one step. If you want to create the directory "./dirA/dirB", the directory "./dirA" must exist. Otherwise you have to do it in two steps; first creates directory "./dirA" and the second one created "./dirA/dirB"

Output: no output.

// path & name of the directory that should be created.
let path = @"/upload/test";

Do SFTP.createDirectory(path);

//The path parameter can be passed as inline value as well.
Do SFTP.createDirectory(@"/upload/test");

deleteDirectory

Signature: (path: text, options: {recursive: true})

Deletes specified directory. Note that the directory must be empty unless Recursive is set to true.

Output: No output.

// path & name of the directory that should be deleted.
let path = (@"/upload";

//to delete sub directories, set recursive to true
return SFTP.deleteDirectory(path, {recursive: true});

listDirectories

Signature: listDirectories(path: text, mask: text, options: {ListOptions}) -> text*.

Lists all files and directories in a specified path. Mask can be used when filtering items in directory. Regular expressions can also be used by prefixing with "regex:"

Optional parameter ListOptions has few properties.

• caseSensitive: boolean - indicates whether to ignore casing or not. Default is false

• recursive: boolean - indicates whether to include nested subdirectories recursively. Default is false.

• include: text - indicates whether to include files or/and directories in the listing

  • All - include both files and directories

  • FilesOnly - include only files

  • DirectoriesOnly - include only directories

Output: Returns a sequence of records where each record contains,

• Name: text - name of the file or directory

• Size: number - size in bytes

• IsDirectory: boolean - true if its a directory, false otherwise

• LastAccessTime: date - Last time item was accessed

• LastModifiedTime: date - Last time item was modified

• CreationTime: date - Time of item creation

// path to the directory.
let path = @"/upload";

//Returns all files under upload directory
let allFiles = SFTP.listDirectories(path, "*");

//Return only the txt files under upload directory
let txtFiles = SFTP.listDirectories(path, "*.txt");

//example with regex. Return all files starting with "A" or "B"
let txtFiles = SFTP.listDirectories(path, "regex:[A|B]");

//Return all files and directories under upload directory.
let allFileAndDirectories = SFTP.listDirectories(path, "*", {include: "All"});

//Return all files and directories either directly under upload directory or within any of its subdirectories.
 let allFileAndDirectories2 = SFTP.listDirectories(path, "*", {include: "All", recursive: true});

fileExists

Signature: (path: text) -> boolean.

Checks if a remote file exists.

Output: true if file exists. false otherwise.

//path to the file
let path = @"/upload/New file.txt";

return SFTP.fileExists(path);

//The path parameter can be passed as inline value as well.
return SFTP.fileExists(@"/upload/New file.txt")

getFileSize

Signature: (path: text) -> number.

Gets the size, in bytes, of a remote file.

Output: Returns the byte value of the file

//path to the file
let path = @"/upload/New file.txt";

return SFTP.getFileSize(path);

//The path parameter can be passed as inline value as well.
return SFTP.getFileSize(@"/upload/New file.txt")

renameFile

Signature: (oldPath: text, newPath: text)

Rename a remote file.

Output: no output

//path to the file
let oldPath = @"/upload/New file.txt";
let newPath = @"/upload/log_202512.txt";

Do SFTP.renameFile(oldPath, newPath);

copyFile

copyFile operation only works if the connecting SFTP server supports it. The standard SFTP protocol does not have a direct remote-to-remote copy command. Hence most of the SFTP server does not have native support for copying files.

Signature: (remoteSourcePath: text, remoteDestinationPath: text, options: {OverwriteIfExistsOptions})

Copies a remote file into the selected destination.

Output: no output

//path to the files
let oldPath = @"/upload/log_1.txt";
let newPath = @"/upload/202512/log_1.txt";

Do SFTP.copyFile(oldPath, newPath, {overwriteIfExist: true});

deleteFile

Signature: (path: text)

Delete a remote file.

Output: no output

//path to the file
let path = @"/upload/log_202512.txt";

Do SFTP.deleteFile(path);

deleteFiles

Signature: (remotePath: text, remoteMask: text, options: {DeleteFilesOptions})

Delete multiple remote files based on mask. Optional parameter DeleteFilesOptions has following properties.

• caseSensitive: boolean - indicates whether to ignore casing or not. Default is false

• recursive: boolean - indicates whether to include nested subdirectories recursively. Default is false.

Output: no output

// path to the directory.
let path = @"/upload";

//Delete all files under upload directory
Do SFTP.deleteFiles(path, '*');

//Delete all txt files under upload directory
Do SFTP.deleteFiles(path, '*.txt');

//example with regex. Delete all files under upload directory starting with "A" or "B"
Do SFTP.deleteFiles(path,"regex:[A|B]");

//Delete all txt files under upload directory or within any of its subdirectories.
Do SFTP.deleteFiles(path, "*.txt", {recursive: true});

uploadFile

Signature: (localFilename: text, remoteFilename: text, options: {UploadOptions})

Uploads a single file to the SFTP Server. Optional parameter UploadOptions has following properties.

• fileTransferMode: text - specifies the behavior if the file already exists.

  • "Overwrite" - Replace the destination file if it exists. Default option

  • "OverwriteIfDifferentSize" - Overwrite only if the destination file size is different

  • "AppendToEnd" - Append content to the end of the existing file

  • "Resume" - Resume a partially transferred file

  • "Skip" - Skip the transfer if the file already exists

• restartPosition: number - Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.The default value is -1.

Output: no output

let localFile= @"D:/testDirectory/log_202512.txt";
let remoteFile= @"/upload/log_202512.txt";

Do SFTP.uploadFile(localFile, remoteFile, {fileTransferMode: 'Overwrite'} );

uploadFiles

Signature: (localPath: text, remotePath: text, localMask: text, options: {UploadMultipleOptions})

Uploads multiple files to the SFTP Server. mask can be used to filter which files to upload. Regular expressions can also be used by prefixing with "regex:"

Optional parameter UploadMultipleOptions has following properties.

• caseSensitive: boolean - indicates whether to ignore casing or not. Default is false

• fileTransferMode: text - specifies the behavior if the file already exists.

  • "Overwrite" - Replace the destination file if it exists. Default option

  • "OverwriteIfDifferentSize" - Overwrite only if the destination file size is different

  • "AppendToEnd" - Append content to the end of the existing file

  • "Resume" - Resume a partially transferred file

  • "Skip" - Skip the transfer if the file already exists

• recursive: boolean - indicates whether to include nested subdirectories recursively. Default is false.

Output: no output

// path to the local file directory. 
//This path should be accessible to the connector agents installed on customer premises
let localFilespath = @"D:/test";

//remote directory path in the SFTP server
let remoteFile= @"/upload";

//Upload all files under local directory "test" to remote directory "upload"
Do SFTP.uploadFile(localFile, remoteFile, "*");

//Upload all txt files under local directory "test" to remote directory "upload"
Do SFTP.uploadFile(localFile, remoteFile, "*.txt");

//Upload all all files starting with "A" or "B" under local directory "test" to remote directory "upload"
Do SFTP.uploadFile(localFile, remoteFile, "regex:[A|B]");

//Upload all txt files under local directory "test" or within any of its subdirectories to remote directory "upload"
//While uploading replace the destination file if it already exists.
Do SFTP.uploadFile(localFile, remoteFile, "*.txt", {fileTransferMode: "Overwrite", recursive: true});

uploadStream

Signature: (localStream: binary, remoteFilename: text, options: {UploadOptions})

Uploads the content of a Flow variable that contains a binary stream. This can for instance be used to upload data from a camera input. Optional parameter UploadOptions has following properties.

• fileTransferMode: text - specifies the behavior if the file already exists.

  • "Overwrite" - Replace the destination file if it exists. Default option

  • "OverwriteIfDifferentSize" - Overwrite only if the destination file size is different

  • "AppendToEnd" - Append content to the end of the existing file

  • "Resume" - Resume a partially transferred file

  • "Skip" - Skip the transfer if the file already exists

• restartPosition: number - Can be used to resume a broken transfer operation. If set to a non-zero positive value, the file being transferred is read starting from that position and is written also starting from provided position.The default value is -1.

Output: no output

//local binary stream. this is typically a flow variable
let localStream= fileRec.data;
let remoteFile= @"/upload/20251203.png";

Do SFTP.uploadStream(localStream, remoteFile, {fileTransferMode: 'Overwrite'} );

downloadFile

Signature: (remotePath: text, localPath: text, options: {UploadMultipleOptions})

Uploads multiple files to the SFTP Server. mask can be used to filter which files to upload. Regular expressions can also be used by prefixing with "regex:"

Optional parameter UploadMultipleOptions has following properties.

• caseSensitive: boolean - indicates whether to ignore casing or not. Default is false

• fileTransferMode: text - specifies the behavior if the file already exists.

  • "Overwrite" - Replace the destination file if it exists. Default option

  • "OverwriteIfDifferentSize" - Overwrite only if the destination file size is different

  • "AppendToEnd" - Append content to the end of the existing file

  • "Resume" - Resume a partially transferred file

  • "Skip" - Skip the transfer if the file already exists

• recursive: boolean - indicates whether to include nested subdirectories recursively. Default is false.

Output: no output

let localFile= @"D:/testDirectory/log_202512.txt";
let remoteFile= @"/upload/log_202512.txt";

Do SFTP.downloadFile(remoteFile, localFile, {fileTransferMode: 'Overwrite'} );

downloadFiles

Signature: (remotePath: text, localPath: text, remoteMask:text, options: {DownloadMultipleOptions})

Download multiple files from the SFTP server to the machine where Flow Connect agent is running. remote mask can be used to filter which files to download. Regular expressions can also be used by prefixing with "regex:"

Optional parameter DownloadMultipleOptions has following properties.

• caseSensitive: boolean - indicates whether to ignore casing or not. Default is false

• fileTransferMode: text - specifies the behavior if the file already exists.

  • "Overwrite" - Replace the destination file if it exists. Default option

  • "OverwriteIfDifferentSize" - Overwrite only if the destination file size is different

  • "AppendToEnd" - Append content to the end of the existing file

  • "Resume" - Resume a partially transferred file

  • "Skip" - Skip the transfer if the file already exists

• fileCopyMode: text - specifies what to do with the original file after download has been completed.

  • "Copy" - Copies the file to the destination without deleting the original. Default option

  • "CopyAndDeleteImmediate" - Copies the file, then immediately deletes the source file after a successful copy

  • "CopyAndDeleteOnCompletion" - Copies the file, but deletes the source only after all transfer or post-processing operations are fully completed

• recursive: boolean - indicates whether to include nested subdirectories recursively. Default is false.

Output: no output

// path to the local file directory. 
//This path should be accessible to the connector agents installed on customer premises
let localPath = @"D:/Download";

//remote directory path in the SFTP server
let remotePath= @"/download";

//Download all files under remote directory "download" to local directory "Download"
Do SFTP.downloadFiles(remotePath, localPath, "*");

//Download all txt files under remote directory "download" to local directory "Download"
Do SFTP.downloadFiles(remotePath, localPath, "*.txt");

//Download all all files starting with "A" or "B" under remote directory "download" to local directory "Download"
Do SFTP.downloadFiles(remotePath, localPath, "regex:[A|B]");

//Dwonload all txt files under remote directory "download" or within any of its subdirectories to local directory "Download"
//While dwonloading replace the destination file if it already exists.
Do SFTP.downloadFiles(remotePath, localPath, "*.txt", {fileTransferMode: "Overwrite", recursive: true});

downloadStream

Signature: (remoteFilename: text)

Download a file from SFTP server and store it as Flow variable.

Output: Raw binary content

let remoteFilePath= @"/upload/20251203.png";

return SFTP.downloadStream(remoteFilePath);