Overview
This node enables interaction with FTP, FTPS (FTP over TLS), and SFTP servers to perform common file operations. It supports secure connections using TLS for FTP and explicit private key or password authentication for SFTP.
Typical use cases include:
- Downloading files from remote servers for further processing.
- Uploading files or data to remote servers.
- Listing directory contents on remote servers.
- Deleting files or directories remotely.
- Renaming files or directories on the server.
For example, you can automate downloading daily reports from an FTPS server or upload processed data files to an SFTP server securely.
Properties
| Name | Meaning |
|---|---|
| Path | The remote path on the FTP/FTPS/SFTP server to operate on (file or directory). |
| Binary Property Name | The name of the binary property in which to store the downloaded file or read the upload binary data. Default is "data". |
Note: These properties are relevant specifically for the Download operation under the Default resource.
Output
The node outputs JSON objects representing the result of the requested operation:
- For Download operation:
- Outputs a JSON object containing a binary property (name configurable via "Binary Property Name") holding the downloaded file data encoded in base64.
- The binary property includes:
data: Base64-encoded file content.mimeType: Always"application/octet-stream".fileName: The basename of the downloaded file.
If the operation fails, the output JSON contains an error field with the error message.
Dependencies
- Requires connection credentials to the FTP/FTPS/SFTP server including host, port, username, password/private key, and optional TLS settings.
- Uses the following npm packages bundled with the node:
basic-ftpfor FTP/FTPS operations.ssh2-sftp-clientfor SFTP operations.
- No additional environment variables are required beyond the provided credentials.
Troubleshooting
- Connection errors: Ensure the FTP/FTPS/SFTP server details and credentials are correct. Check network connectivity and firewall rules.
- TLS version issues: If connecting via FTPS, the node tries multiple TLS versions automatically. If connection fails due to TLS version mismatch, verify server TLS configuration.
- File not found: Verify the remote path is correct and accessible by the user.
- Permission denied: Ensure the user has sufficient permissions for the requested operation.
- Unknown operation error: This indicates an unsupported operation was requested; verify the operation parameter is set correctly.
- Timeouts: Increase timeout settings if large files or slow networks cause timeouts.