Help Desk

Submit a ticket My Tickets
Welcome
Login

SFTP Connector Command Reference

SFTP BizApp

Connections

SFTP Connector

This connection sets up the credentials and connection parameters required for interacting with a single SFTP Server.

Inputs

Input Type Detail Notes
Host TextField The host domain or IP that the server is located at. (i.e. 34.23.34.45 or sftp.examplecompany.net)
Port NumberField The port the server is running on.
Username TextField The username used to log into the server.
Password TextField The password for the username provided for this SFTP server. (This will be ignored if using private key authentication)
Private Key TextField The name of the private key file that you added to the connection.
Private Key Password TextField The password for the private key used for authentication. Leave this blank if there is no password.
Connection Timeout NumberField How long to wait before aborting the attempt to connect to the SFTP server. If your server is under high load or know for being slow use a larger number.

Commands

Delete

Deletes file(s) and folder(s) on the SFTP server.

Inputs

Input Type Detail Notes
File(s) TextField The files and folders to delete. You can use * to match multiple files and folders.
Skip folders BooleanField When this is checked, any folders that match the File(s) specified will be ignored.
Recursive BooleanField When this is checked, folders marked for deletion will be deleted along with their entire contents.

Outputs

Output Output Type Notes
Deleted files Json
Deleted folders Json
All items deleted Json

Exit Codes

Code Type Detail
0 Success The task ran successfully.
2 Error The task failed.
6 Error Directories marked for deletion were not set to be skipped and recursive was not set.

Download File

Download a single file from the SFTP server.

Inputs

Input Type Detail Notes
File TextField The file to retrieve.
Parallel Download BooleanField Optional: Select this field to use parallel downloads. In the case of a very large file, parallel downloads could offer better performance at the cost of using more resources
Number of Threads NumberField Optional: When using parallel downloads, select the number of threads. If you are unsure of how many threads to use, leave the default value selected

Outputs

Output Output Type Notes
Downloaded File File

Exit Codes

Code Type Detail
0 Success The task ran successfully.
2 Error The task failed.

Get

Get file(s) from the SFTP server.

Inputs

Input Type Detail Notes
File(s) TextField The files to retrieve. You can use * to match multiple files and folders.
Destination TextField The destination for the file(s). If multiple files are being retrieved, this must be a directory.

Outputs

Output Output Type Notes
Retrieved files Json
Retrieved files (text) String

Exit Codes

Code Type Detail
0 Success The task ran successfully.
2 Error The task failed.
6 Error Directories were not skipped and marked for deletion, but recursive was not set.

List Directory

List the files in a directory on the SFTP server.

Inputs

Input Type Detail Notes
Directory TextField Directory to list the contents of. You can use * to list multiple files and folders within a directory.
Detail level DropdownField Show the full details of the files/folders in the directory.

Outputs

Output Output Type Notes
Remote files Json

Exit Codes

Code Type Detail
0 Success The task ran successfully.
2 Error The task failed.
5 Error The specified directory was not found.

Make Directory

Make a new directory on the SFTP server.

Inputs

Input Type Detail Notes
Directory TextField The directory to create on the SFTP server.
Recursive BooleanField When this is checked, the entire path of the directory will be created if it doesn't exist.

Outputs

None

Exit Codes

Code Type Detail
0 Success The task ran successfully.
2 Error The task failed.
4 Error Error creating the specified directory.
6 Success The directory already exists.

Move

Move file(s) on the SFTP server.

Inputs

Input Type Detail Notes
File(s) TextField The files to retrieve. You can use * to match multiple files and folders.
Destination TextField The destination for the file(s). If multiple files are being retrieved, this must be a directory.

Outputs

Output Output Type Notes
Moved files Json
Moved files (text) String

Exit Codes

Code Type Detail
0 Success The task ran successfully.
2 Error The task failed.
4 Error When moving multiple files, the destination must be an existing directory
5 Error No files found with the specified source files

Put

Put file(s) on the SFTP server.

Inputs

Input Type Detail Notes
File(s) FileField The file(s) to upload. You can use * to match multiple files and folders.
Destination TextField When this is checked, any folders that match the File(s) specified will be ignored.

Outputs

Output Output Type Notes
Remote files Json
Remote files (text) String

Exit Codes

Code Type Detail
0 Success The task ran successfully.
2 Error The task failed.
6 Error Directories were not skipped and marked for deletion, but recursive was not set.
B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.