2 Home

gitea_admin edited this page 2026-03-11 14:40:09 +00:00

Table of Contents

• SFTP Source
• Metadata
• Properties
• Dependencies

SFTP Source

Receive data from an SFTP server.

Metadata

Property	Value
Type	source
Group	FTP
Namespace	File
Support Level	Stable
Provider	Apache Software Foundation

Properties

Name	Type	Required	Default	Description
connectionHost	string	✓		The hostname of the SFTP server.
connectionPort	string	✓	22	The port of the FTP server.
username	string			The username to access the SFTP server.
password	string			The password to access the SFTP server.
directoryName	string	✓		The starting directory.
passiveMode	boolean		false	Sets the passive mode connection.
recursive	boolean		false	If a directory, look for files in all sub-directories as well.
idempotent	boolean		true	Skip already-processed files.
ignoreFileNotFoundOrPermissionError	boolean		false	Whether to ignore when (trying to list files in directories or when downloading a file), which does not exist or due to permission error. By default when a directory or file does not exists or insufficient permission, then an exception is thrown. Setting this option to true allows to ignore that instead.
binary	boolean		false	Specifies the file transfer mode, BINARY or ASCII. Default is ASCII (false).
privateKeyFile	string			Set the private key file so that the SFTP endpoint can do private key verification.
privateKeyPassphrase	string			Set the private key file passphrase so that the SFTP endpoint can do private key verification.
privateKeyUri	string			Set the private key file (loaded from classpath by default) so that the SFTP endpoint can do private key verification.
strictHostKeyChecking	string		no	Sets whether to use strict host key checking.
useUserKnownHostsFile	boolean		true	If knownHostFile has not been explicit configured then use the host file from System.getProperty(user.home)/.ssh/known_hosts.
autoCreate	boolean		true	Automatically create starting directory.
delete	boolean		false	If true, the file will be deleted after it is processed successfully.

Dependencies

• camel:ftp
• camel:core
• camel:kamelet