Overview
This node connects to an SFTP server to perform file operations such as listing files, downloading, uploading, renaming, deleting files or directories, and creating directories. It is useful for automating file management tasks on remote servers, for example, listing all files in a directory (optionally recursively), downloading files for processing, or uploading files from local sources.
Use Case Examples
- Listing all files in a remote directory to get an overview of available files.
- Downloading a specific file from the SFTP server to use in further workflow steps.
- Uploading a file to the SFTP server from binary data or a local path.
- Renaming or moving files or directories on the remote server.
Properties
| Name | Meaning |
|---|---|
| Path | The remote directory path to list contents of. Required for listing files. |
| Recursive | Whether to list all subdirectories recursively when listing files. |
Output
JSON
name- Name of the file or directory.type- Type of the item (e.g., file or directory).size- Size of the file in bytes.modifyTime- Last modification time of the file or directory.accessTime- Last access time of the file or directory.path- Full path of the file or directory on the remote server.
Dependencies
- Requires an SFTP server connection with credentials including host, port, username, and either password or private key authentication.
Troubleshooting
- Common errors include 'Path does not exist' if the specified directory path is invalid or inaccessible.
- Errors related to authentication failure if credentials are incorrect or missing.
- Errors when trying to list a path that is a file instead of a directory.
- Timeout errors if the SFTP server is unreachable or slow to respond.
Links
- ssh2-sftp-client NPM Package - The underlying library used for SFTP operations in this node.
- SFTP Protocol Specification - Technical details about the SFTP protocol used for file transfers.