Downloads
Download multiple files from an FTP server.

Download multiple files from an FTP server.

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

The directory to list

host*string

Hostname of the remote server

actionstring

Possible Values

MOVEDELETENONE

The action to take on downloaded files

enableSshRsa1booleanstring

Defaultfalse

Enable the RSA/SHA1 algorithm (disabled by default)

moveDirectorystring

The destination directory in case of MOVE

options

Default

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

Definitions

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

connectionTimeoutstring

DefaultPT30S

Formatduration

The timeout for the initial control connection.

controlKeepAliveReplyTimeoutstring

DefaultPT30S

Formatduration

The control keep-alive reply timeout.

controlKeepAliveTimeoutstring

DefaultPT30S

Formatduration

The control keep-alive timeout.

Ensures the socket stays alive after downloading a large file.

dataTimeoutstring

DefaultPT30S

Formatduration

The timeout for opening the data channel.

socketTimeoutstring

DefaultPT30S

Formatduration

The socket timeout.

passiveModebooleanstring

Defaulttrue

Whether to use a passive mode. Passive mode is generally considered more secure as it's less likely to encounter issues with NAT and firewalls. Therefore, this property is by default set to true. To use active mode instead, set the property to false.

passwordstring

Password on the remote server

portstring

Default21

Port of the remote server

proxyHoststring

FTP proxy host

proxyPortstring

FTP proxy port

proxyTypestring

Possible Values

DIRECTHTTPSOCKS

FTP proxy type

recursivebooleanstring

Defaultfalse

List files recursively

regExpstring

A regexp to filter on full path

remoteIpVerificationbooleanstring

Defaulttrue

Ensure the server IP responding matches the one that received the request.

rootDirbooleanstring

Defaulttrue

Is the path relative to the user's home directory

usernamestring

Username on the remote server

Outputs

filesarray

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

outputFilesobject

SubTypestring

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

Core Plugins and tasks

Tasks that provide Kestra's built-in orchestration, I/O, and observability capabilities.

CoreStorageScript

Resend

Tasks that manage domains and send email via the Resend API.

Messaging

AWS

Enterprise

AWS plugin for Kestra

AlertingCloudStorageBatch

Downloads
Download multiple files from an FTP server.

More Plugins in this Category

Core Plugins and tasks

Resend

AWS

1.2.1

DownloadsDownload multiple files from an FTP server.

More Plugins in this Category

Core Plugins and tasks

Resend

AWS

1.2.1

Downloads
Download multiple files from an FTP server.