🚀 New! Kestra raises $3 million to grow Learn more

Downloads Downloads

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

Download multiple files from SFTP server

Examples

Download a list of files and move it to an archive folders

yaml
id: "downloads"
type: "io.kestra.plugin.fs.sftp.Downloads"
host: localhost
port: 22
username: foo
password: pass
from: "/in/"
interval: PT10S
action: MOVE
moveDirectory: "/archive/"

Properties

from

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The directory to list

host

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

Hostname of the remote server

moveDirectory

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

The destination directory in case off MOVE

action

  • Type: string
  • Dynamic: ✔️
  • Required:
  • Possible Values:
    • MOVE
    • DELETE

The action to do on find files

keyfile

  • Type: string
  • Dynamic: ✔️
  • Required:

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

  • Type: string
  • Dynamic: ✔️
  • Required:

Passphrase of the ssh key

password

  • Type: string
  • Dynamic: ✔️
  • Required:

Password on the remote server

port

  • Type: string
  • Dynamic: ✔️
  • Required:
  • Default: 22

Port of the remote server

proxyHost

  • Type: string
  • Dynamic: ✔️
  • Required:

SFTP proxy host

proxyPassword

  • Type: string
  • Dynamic: ✔️
  • Required:

SFTP proxy password

proxyPort

  • Type: string
  • Dynamic: ✔️
  • Required:

SFTP proxy port

proxyType

  • Type: string
  • Dynamic: ✔️
  • Required:

SFTP proxy type

proxyUser

  • Type: string
  • Dynamic: ✔️
  • Required:

SFTP proxy user

recursive

  • Type: boolean
  • Dynamic:
  • Required:
  • Default: false

List file recursively

regExp

  • Type: string
  • Dynamic: ✔️
  • Required:

A regexp to filter on full path

rootDir

  • Type: boolean
  • Dynamic: ✔️
  • Required:
  • Default: true

Is path is relative to root dir

username

  • Type: string
  • Dynamic: ✔️
  • Required:

Username on the remote server

Outputs

files

The bucket of the downloaded file

Definitions

File

accessDate

  • Type: string
  • Dynamic:
  • Required:

fileType

  • Type: string
  • Dynamic:
  • Required:
  • Possible Values:
    • FOLDER
    • FILE
    • FILE_OR_FOLDER
    • IMAGINARY

flags

  • Type: integer
  • Dynamic:
  • Required:

groupId

  • Type: integer
  • Dynamic:
  • Required:

name

  • Type: string
  • Dynamic:
  • Required:

path

  • Type: string
  • Dynamic:
  • Required:

permissions

  • Type: integer
  • Dynamic:
  • Required:

size

  • Type: integer
  • Dynamic:
  • Required:
  • Type: boolean
  • Dynamic:
  • Required:
  • Default: false

updatedDate

  • Type: string
  • Dynamic:
  • Required:

userId

  • Type: integer
  • Dynamic:
  • Required: