SFTP
Transfer files via SFTP (SSH File Transfer Protocol)
Upload, download, list, and manage files on remote servers via SFTP. Supports both password and private key authentication for secure file transfers.
| Parameter | Type | Required | Description |
|---|
host | string | Yes | No description |
port | number | Yes | No description |
username | string | Yes | No description |
password | string | No | No description |
privateKey | string | No | No description |
passphrase | string | No | No description |
remotePath | string | Yes | No description |
files | file[] | No | No description |
fileContent | string | No | No description |
fileName | string | No | No description |
overwrite | boolean | No | No description |
permissions | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the upload was successful |
uploadedFiles | json | Array of uploaded file details (name, remotePath, size) |
message | string | Operation status message |
| Parameter | Type | Required | Description |
|---|
host | string | Yes | No description |
port | number | Yes | No description |
username | string | Yes | No description |
password | string | No | No description |
privateKey | string | No | No description |
passphrase | string | No | No description |
remotePath | string | Yes | No description |
encoding | string | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the download was successful |
file | file | Downloaded file stored in execution files |
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) |
message | string | Operation status message |
| Parameter | Type | Required | Description |
|---|
host | string | Yes | No description |
port | number | Yes | No description |
username | string | Yes | No description |
password | string | No | No description |
privateKey | string | No | No description |
passphrase | string | No | No description |
remotePath | string | Yes | No description |
detailed | boolean | No | No description |
| 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 |
message | string | Operation status message |
| Parameter | Type | Required | Description |
|---|
host | string | Yes | No description |
port | number | Yes | No description |
username | string | Yes | No description |
password | string | No | No description |
privateKey | string | No | No description |
passphrase | string | No | No description |
remotePath | string | Yes | No description |
recursive | boolean | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the deletion was successful |
deletedPath | string | Path that was deleted |
message | string | Operation status message |
| Parameter | Type | Required | Description |
|---|
host | string | Yes | No description |
port | number | Yes | No description |
username | string | Yes | No description |
password | string | No | No description |
privateKey | string | No | No description |
passphrase | string | No | No description |
remotePath | string | Yes | No description |
recursive | boolean | No | No description |
| Parameter | Type | Description |
|---|
success | boolean | Whether the directory was created successfully |
createdPath | string | Path of the created directory |
message | string | Operation status message |
