SFTP Connector

[#1]

Read, write, move and delete files on an SFTP server

Connections

Basic Username/Password

Basic Username and Password connection

The basic auth connection is used to connect to SFTP servers that support username / password login.
Consult your SFTP server administrator to determine which login method the server supports.

Input	Comments	Default
Password	Password for SFTP authentication
Username
Host	The address of the SFTP server. This should be either an IP address or hostname.
Port	The port of the SFTP server.	22
Timeout	How long the client will await a request.	3000
Enable Unsecure Server Host Key Algorithms	If true, unsecure server host key algorithms will be added to the connection.	false
Enable Unsecure Ciphers	If true, CBC ciphers will be added to the connection.	false
Custom Server Host Key Algorithms	A comma-separated list of custom server host key algorithms. Overrides the default server host key algorithms. Algorithm order matters. Advanced setting.
Custom Ciphers	A comma-separated list of custom ciphers. Overrides the default ciphers. Cipher order matters. Advanced setting.

Private Key

Private Key connection

The private key connection allows you to access an SFTP server via SSH public/private key authentication.
You will need to generate a public/private key pair, and ensure that your public key is stored on the SFTP server that you are connecting to.
Then, you can authenticate with the SFTP server using a username and corresponding private key.

Input	Comments	Default
Private Key	SSH private key
Key Passphrase	Passphrase for the private key. Leave blank if none.
Password	Though uncommon, some SFTP servers that use private keys may also require a password. Leave blank if none.
Username
Host	The address of the SFTP server. This should be either an IP address or hostname.
Port	The port of the SFTP server.	22
Timeout	How long the client will await a request.	3000
Enable Unsecure Server Host Key Algorithms	If true, unsecure server host key algorithms will be added to the connection.	false
Enable Unsecure Ciphers	If true, CBC ciphers will be added to the connection.	false
Custom Server Host Key Algorithms	A comma-separated list of custom server host key algorithms. Overrides the default server host key algorithms. Algorithm order matters. Advanced setting.
Custom Ciphers	A comma-separated list of custom ciphers. Overrides the default ciphers. Cipher order matters. Advanced setting.

Actions

Append File

Append data to an existing file on a SFTP server.

Input	Comments	Default
Connection
Path	Path on SFTP server to append file.
Data	Text to append to the file.

Create Directory

Create a new directory. If the recursive flag is set to true, the method will create any directories in the path which do not already exist.

Input	Comments	Default
Connection
Path	Path of directory on an SFTP server to list files of
Recursive	If true, create any missing directories in the path as well	true

Delete File

Delete a file from a SFTP server

Input	Comments	Default
Connection
Path	Path of file to delete

Fast Get

Read a file from SFTP

Input	Comments	Default
Connection
Path	Path of file on SFTP server to read data from
Always Return Buffer	Always treat the file as a binary file with content type 'application/octet-stream', even if it is a text file. This is helpful if you are processing non-UTF-8 text files, as the runner assumes text files are UTF-8.	false

List Directory

List files and directories in a directory on an SFTP server. Optionally list files in subdirectories.

Input	Comments	Default
Connection
Path	Path of directory on an SFTP server to list files of
Pattern	Glob-style string for listing specific files	*
Include Subdirectories	If true, will list files in all subdirectories. If false, only lists files in the specified directory.	false
Include Directories	If true, will list directories in addition to files. If false, only lists files.	false

Move File

Move a file on an SFTP server

Input	Comments	Default
Connection
Source Path	Path of file to move
Destination Path	Path of file to move

Read File

Read a file from SFTP

Input	Comments	Default
Connection
Path	Path of file on SFTP server to read data from
Always Return Buffer	Always treat the file as a binary file with content type 'application/octet-stream', even if it is a text file. This is helpful if you are processing non-UTF-8 text files, as the runner assumes text files are UTF-8.	false

Stat File

Pull statistics about a file

Input	Comments	Default
Connection
Path	Path of file on SFTP server to read data from

Write File

Write a file to SFTP

Input	Comments	Default
Connection
Path	Path to file on SFTP server.
Data	Text to write into the file.