SFTP TP Download
AI-generatedSummary
Connects to an SFTP server and downloads the specified remote file into an output item’s binary property. It can append legacy SSH algorithms for compatibility, optionally delete the remote file after download, or skip missing files.
Inputs
- remotePath (required) — Absolute path of the remote file to download.
- binaryPropertyName (required) — Output binary property name; defaults to
data. - options — Optional settings:
removeAfterDownloaddeletes the remote file after a successful download;fileNameoverrides the output binary filename (otherwise the remote path’s basename is used);mimeTypesets the binary MIME type (defaults toapplication/octet-stream);skipMissingemits a skipped result if the file is missing instead of failing. - sshOptions — Optional SSH compatibility settings. Comma-separated KEX, host key, cipher, and HMAC algorithms are appended to defaults, which include legacy algorithms. Also supports a client identification string, connection timeout in milliseconds (default 20000), and SSH handshake logging to n8n logs.
- SFTP credentials (required) — SFTP connection credentials provide the host, username, and password and/or private key; the port defaults to 22.
Output shape
One output item per input item, returned on the main output.
A successful download returns JSON fields
success,remotePath,bytes,fileName, andmimeType, plus the downloaded file under the configured binary property. IfremoveAfterDownloadis enabled, JSON also includesremoved: true. WithskipMissing, a missing file yields JSON withsuccess: false,remotePath,skipped: true, and a reason, without binary data. Other errors fail the operation unless the node is configured to continue on fail, in which case an error item is returned.