Download

Download a file from an SFTP server.

yaml
type: "io.kestra.plugin.fs.sftp.Download"

Examples

yaml
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 *string

The fully-qualified URIs that point to destination path

host *string

Hostname of the remote server

enableSshRsa1 booleanstring

Default false

Enable the RSA/SHA1 algorithm (disabled by default)

keyExchangeAlgorithm string

Configures Key exchange algorithm explicitly e. g diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1.

keyfile string

Private keyfile in the PEM file 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

passphrase string

Passphrase of the ssh key

password string

Password on the remote server

port string

Default 22

Port of the remote server

proxyHost string

SFTP proxy host

proxyPassword string

SFTP proxy password

proxyPort string

SFTP proxy port

proxyType string

SFTP proxy type

proxyUser string

SFTP proxy user

rootDir booleanstring

Default true

Is the path relative to the users home directory

username string

Username on the remote server

Outputs

from string

Format uri

The fully-qualified URIs that point to source data

to string

Format uri

The fully-qualified URIs that point to destination path

​Download

Download