Description

n8n-nodes-sftp-transfer

n8n community node to upload and download files over SFTP.

Installation

In n8n, install the community package:

n8n-nodes-sftp-transfer

Or follow the official guide:
https://docs.n8n.io/integrations/community-nodes/installation/

Operations

SFTP Transfer

• Download

– Download file from remote SFTP path.
– Output binary field is configurable.
– Optional fastGet mode with concurrency/chunk controls.

• Upload

– Upload from input binary field or plain text content.
– Optional creation of remote directories.
– Optional fastPut mode with configurable concurrency and chunkSize.

Credentials

Credential type: SFTP Transfer API (sftpTransferApi)

Fields:

• Host (required)
• Port (default: 22)
• Username (required)
• Password (optional if Private Key is provided)
• Private Key (optional if Password is provided)
• Passphrase (optional)

At least one of Password or Private Key must be set.

Node parameters

• Operation: Download or Upload
• Remote Path: full file path in SFTP

Download parameters

• Put Output File in Field: output binary field name
• Options.Enable Concurrent Reads: enable fastGet
• Options.Max Concurrent Reads: fastGet concurrency
• Options.Chunk Size (KB): fastGet chunk size
• Options.Timeout: connection timeout in milliseconds

Upload parameters

• Input Is Binary: use binary input or plain text
• Input Binary Field: binary field name (if binary mode is enabled)
• File Content: plain text content (if binary mode is disabled)
• Options.Create Directories: create missing remote directories
• Options.Use fastPut: enable fastPut upload
• Options.fastPut Concurrency: fastPut concurrency
• Options.fastPut Chunk Size (KB): fastPut chunk size
• Options.Timeout: connection timeout in milliseconds

Development

npm install
npm run build
npm run lint
npm run dev

Resources

• n8n community nodes docs: https://docs.n8n.io/integrations/#community-nodes
• ssh2-sftp-client docs: https://github.com/theophilusx/ssh2-sftp-client