File system Downloads

File system Downloads
Certified
Download multiple files from FTP

Lists matching files then downloads them to internal storage. Respects maxFiles (default 25) and optional post-download action (MOVE/DELETE). Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home.

yaml
type: io.kestra.plugin.fs.ftp.Downloads

Examples

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

yaml
id: fs_ftp_downloads
namespace: company.team

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

Properties

from *string

Directory URI to list

host *string

Remote host

action string

Possible Values

MOVEDELETENONE

Action on downloaded files

enableSshRsa1 booleanstring

Defaultfalse

Enable the RSA/SHA1 algorithm (disabled by default)

maxFiles integerstring

Default25

Maximum files to retrieve

moveDirectory string

Destination directory when action is MOVE

options

Default

{
  "connectionTimeout": "PT30S",
  "dataTimeout": "PT30S",
  "socketTimeout": "PT30S",
  "controlKeepAliveTimeout": "PT30S",
  "controlKeepAliveReplyTimeout": "PT30S"
}

FTP client options

Definitions

io.kestra.plugin.fs.ftp.FtpInterface-Options

connectionTimeoutstring

DefaultPT30S

Control connection timeout

Maximum time to open the control channel. Default 30s.

controlKeepAliveReplyTimeoutstring

DefaultPT30S

Keep-alive reply timeout

How long to wait for keep-alive responses before failing. Default 30s.

controlKeepAliveTimeoutstring

DefaultPT30S

Control keep-alive interval

Sends keep-alive commands during long transfers. Default 30s.

dataTimeoutstring

DefaultPT30S

Data channel timeout

Maximum time to open the data socket. Default 30s.

socketTimeoutstring

DefaultPT30S

Socket read timeout

Timeout for socket reads and writes once connected. Default 30s.

passiveMode booleanstring

Defaulttrue

Use passive data connections

Passive mode avoids most firewall and NAT issues and is enabled by default (true). Set to false to force active mode.

password string

Password

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

port string

Default21

Remote port

proxyHost string

FTP proxy hostname

proxyPort string

FTP proxy port

proxyType string

Possible Values

DIRECTHTTPSOCKS

FTP proxy type

recursive booleanstring

Defaultfalse

List files recursively

regExp string

Regexp filter on full path

remoteIpVerification booleanstring

Defaulttrue

Verify data channel IP

Ensures the responding server IP matches the control connection to prevent spoofed data channels.

rootDir booleanstring

Defaulttrue

Treat path as user home root

If true (default), remote paths are resolved relative to the authenticated user's home directory.

username string

Username

Outputs

files array

Metadata of downloaded files

Definitions

io.kestra.plugin.fs.vfs.models.File

accessDatestring

Formatdate-time

fileTypestring

Possible Values

FOLDERFILEFILE_OR_FOLDERIMAGINARY

flagsinteger

groupIdinteger

namestring

pathstring

Formaturi

permissionsinteger

sizeinteger

symbolicLinkboolean

Defaultfalse

updatedDatestring

Formatdate-time

userIdinteger

outputFiles object

SubTypestring

The downloaded files as a map of from/to URIs

Liquibase

Tasks that run Liquibase change management commands.

Data

OPA (Open Policy Agent)

Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

File system DownloadsCertifiedDownload multiple files from FTP

File system Downloads

More Plugins in this Category

Liquibase

OPA (Open Policy Agent)

File system Downloads
Certified
Download multiple files from FTP