DownloadsDownloads
DownloadsCertified

Download multiple files from an SFTP server.

Download multiple files from an SFTP server.

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

Download a list of files and move them to an archive folder

yaml
id: fs_sftp_downloads
namespace: company.team

tasks:
  - id: downloads
    type: io.kestra.plugin.fs.sftp.Downloads
    host: localhost
    port: "22"
    username: foo
    password: "{{ secret('SFTP_PASSWORD') }}"
    from: "/in/"
    interval: PT10S
    action: MOVE
    moveDirectory: "/archive/"
Properties

The directory to list

Hostname of the remote server

Possible Values
MOVEDELETENONE

The action to take on downloaded files

Defaultfalse

Enable the RSA/SHA1 algorithm (disabled by default)

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).

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

The destination directory in case of MOVE

Passphrase for the SSH key

Password on the remote server

Default22

Port of the remote server

SFTP proxy address

SFTP proxy password

SFTP proxy port

SFTP proxy type

SFTP proxy username

Defaultfalse

List files recursively

A regexp to filter on full path

Defaulttrue

Is the path relative to the user's home directory

Username on the remote server

Metadata of downloaded files.

Definitions
accessDatestring
Formatdate-time
fileTypestring
Possible Values
FOLDERFILEFILE_OR_FOLDERIMAGINARY
flagsinteger
groupIdinteger
namestring
pathstring
Formaturi
permissionsinteger
sizeinteger
symbolicLinkboolean
Defaultfalse
updatedDatestring
Formatdate-time
userIdinteger
SubTypestring

The downloaded files as a map of from/to URIs.