download
Download a file from an SFTP server.
Download a file from an SFTP server.
Download a file from an SFTP server.
type: "io.kestra.plugin.fs.sftp.download"Examples
id: fs_sftp_download
namespace: company.team
tasks:
- id: download
type: io.kestra.plugin.fs.sftp.Download
host: localhost
port: "22"
username: foo
password: "{{ secret('SFTP_PASSWORD') }}"
from: "/in/file.txt"
Properties
from*Requiredstring
host*Requiredstring
Hostname of the remote server
enableSshRsa1booleanstring
falseEnable the RSA/SHA1 algorithm (disabled by default)
keyExchangeAlgorithmstring
Configures the key exchange algorithm explicitly (e.g., diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1).
keyfilestring
Private key file in the PEM format to connect to a remote server using SSH
To generate a PEM-format key from OpenSSH, use the following command: ssh-keygen -m PEM
passphrasestring
Passphrase for the SSH key
passwordstring
Password on the remote server
portstring
22Port of the remote server
proxyAddressstring
SFTP proxy address
proxyPasswordstring
SFTP proxy password
proxyPortstring
SFTP proxy port
proxyTypestring
SFTP proxy type
proxyUsernamestring
SFTP proxy username
rootDirbooleanstring
trueIs the path relative to the user's home directory
usernamestring
Username on the remote server
Outputs
fromstring
uriThe fully-qualified URIs that point to source data
tostring
uriThe fully-qualified URIs that point to destination path
