SFTP
Transfer files via SFTP (SSH File Transfer Protocol)
Configuration
Upload Files
Operation
Upload Files
SFTP Host*
sftp.example.com or 192.168.1.100
SFTP Port
22
Username*
sftp-user
Authentication Method
Select...
Password
••••••••
Private Key
plaintext
-----BEGIN OPENSSH PRIVATE KEY-----\n...
Passphrase
••••••••
Remote Path*
/home/user/uploads
Files to Upload
Select files to upload
File Reference
Reference file from previous block (e.g., {{block_name.file}})
Overwrite Existing Files
Enabled
File Permissions
0644
Upload Files (
sftp_upload)Upload files to a remote SFTP server
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
host | string | Yes | SFTP server hostname or IP address |
port | number | Yes | SFTP server port (default: 22) |
username | string | Yes | SFTP username |
password | string | No | Password for authentication (if not using private key) |
privateKey | string | No | Private key for authentication (OpenSSH format) |
passphrase | string | No | Passphrase for encrypted private key |
remotePath | string | Yes | Destination directory on the remote server |
files | file[] | No | Files to upload |
fileContent | string | No | Direct file content to upload (for text files) |
fileName | string | No | File name when using direct content |
overwrite | boolean | No | Whether to overwrite existing files (default: true) |
permissions | string | No | File permissions (e.g., 0644) |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the upload was successful |
uploadedFiles | json | Array of uploaded file details (name, remotePath, size) |
Create File
Operation
Create File
SFTP Host*
sftp.example.com or 192.168.1.100
SFTP Port
22
Username*
sftp-user
Authentication Method
Select...
Password
••••••••
Private Key
plaintext
-----BEGIN OPENSSH PRIVATE KEY-----\n...
Passphrase
••••••••
Remote Path*
/home/user/uploads
Overwrite Existing Files
Enabled
File Permissions
0644
File Name*
filename.txt
File Content*
plaintext
Text content to write to the file
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the operation was successful |
uploadedFiles | json | Array of uploaded file details |
fileName | string | Downloaded file name |
content | string | Downloaded file content |
size | number | File size in bytes |
entries | json | Directory listing entries |
count | number | Number of entries |
deletedPath | string | Path that was deleted |
createdPath | string | Directory that was created |
message | string | Operation status message |
error | string | Error message if operation failed |
Download File
Operation
Download File
SFTP Host*
sftp.example.com or 192.168.1.100
SFTP Port
22
Username*
sftp-user
Authentication Method
Select...
Password
••••••••
Private Key
plaintext
-----BEGIN OPENSSH PRIVATE KEY-----\n...
Passphrase
••••••••
Remote Path*
/home/user/uploads
Output Encoding
Select...
Download File (
sftp_download)Download a file from a remote SFTP server
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
host | string | Yes | SFTP server hostname or IP address |
port | number | Yes | SFTP server port (default: 22) |
username | string | Yes | SFTP username |
password | string | No | Password for authentication (if not using private key) |
privateKey | string | No | Private key for authentication (OpenSSH format) |
passphrase | string | No | Passphrase for encrypted private key |
remotePath | string | Yes | Path to the file on the remote server |
encoding | string | No | Output encoding: utf-8 for text, base64 for binary (default: utf-8) |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the download was successful |
fileName | string | Name of the downloaded file |
content | string | File content (text or base64 encoded) |
size | number | File size in bytes |
encoding | string | Content encoding (utf-8 or base64) |
List Directory
Operation
List Directory
SFTP Host*
sftp.example.com or 192.168.1.100
SFTP Port
22
Username*
sftp-user
Authentication Method
Select...
Password
••••••••
Private Key
plaintext
-----BEGIN OPENSSH PRIVATE KEY-----\n...
Passphrase
••••••••
Remote Path*
/home/user/uploads
Show Detailed Info
Disabled
List Directory (
sftp_list)List files and directories on a remote SFTP server
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
host | string | Yes | SFTP server hostname or IP address |
port | number | Yes | SFTP server port (default: 22) |
username | string | Yes | SFTP username |
password | string | No | Password for authentication (if not using private key) |
privateKey | string | No | Private key for authentication (OpenSSH format) |
passphrase | string | No | Passphrase for encrypted private key |
remotePath | string | Yes | Directory path on the remote server |
detailed | boolean | No | Include detailed file information (size, permissions, modified date) |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the operation was successful |
path | string | Directory path that was listed |
entries | json | Array of directory entries with name, type, size, permissions, modifiedAt |
count | number | Number of entries in the directory |
Delete File/Directory
Operation
Delete File/Directory
SFTP Host*
sftp.example.com or 192.168.1.100
SFTP Port
22
Username*
sftp-user
Authentication Method
Select...
Password
••••••••
Private Key
plaintext
-----BEGIN OPENSSH PRIVATE KEY-----\n...
Passphrase
••••••••
Remote Path*
/home/user/uploads
Recursive Delete
Disabled
Delete File/Directory (
sftp_delete)Delete a file or directory on a remote SFTP server
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
host | string | Yes | SFTP server hostname or IP address |
port | number | Yes | SFTP server port (default: 22) |
username | string | Yes | SFTP username |
password | string | No | Password for authentication (if not using private key) |
privateKey | string | No | Private key for authentication (OpenSSH format) |
passphrase | string | No | Passphrase for encrypted private key |
remotePath | string | Yes | Path to the file or directory to delete |
recursive | boolean | No | Delete directories recursively |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the deletion was successful |
deletedPath | string | Path that was deleted |
Create Directory
Operation
Create Directory
SFTP Host*
sftp.example.com or 192.168.1.100
SFTP Port
22
Username*
sftp-user
Authentication Method
Select...
Password
••••••••
Private Key
plaintext
-----BEGIN OPENSSH PRIVATE KEY-----\n...
Passphrase
••••••••
Remote Path*
/home/user/uploads
Create Parent Directories
Enabled
Create Directory (
sftp_mkdir)Create a directory on a remote SFTP server
Input
| Parameter | Type | Required | Description |
|---|---|---|---|
host | string | Yes | SFTP server hostname or IP address |
port | number | Yes | SFTP server port (default: 22) |
username | string | Yes | SFTP username |
password | string | No | Password for authentication (if not using private key) |
privateKey | string | No | Private key for authentication (OpenSSH format) |
passphrase | string | No | Passphrase for encrypted private key |
remotePath | string | Yes | Path for the new directory |
recursive | boolean | No | Create parent directories if they do not exist |
Output
| Parameter | Type | Description |
|---|---|---|
success | boolean | Whether the directory was created successfully |
createdPath | string | Path of the created directory |
Usage Instructions
Upload, download, list, and manage files on remote servers via SFTP. Supports both password and private key authentication for secure file transfers.
Notes
- Category:
tools - Type:
sftp