list
List files from an FTP server directory.

List files from an FTP server directory.

yaml
type: "io.kestra.plugin.fs.ftp.list"

Examples

yaml
id: fs_ftp_list
namespace: company.team

tasks:
  - id: list
    type: io.kestra.plugin.fs.ftp.List
    host: localhost
    port: 21
    username: foo
    password: "{{ secret('FTP_PASSWORD') }}"
    from: "/upload/dir1/"
    regExp: ".*\/dir1\/.*.(yaml|yml)"

Properties

from*string

The fully-qualified URIs that point to path

host*string

Hostname of the remote server

enableSshRsa1booleanstring

Defaultfalse

Enable the RSA/SHA1 algorithm (disabled by default)

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.

to ensure the socket be alive after download huge 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 file recursively

regExpstring

A regexp to filter on full path

remoteIpVerificationbooleanstring

Defaulttrue

Control that the server ip that emit the request is the same than send response.

rootDirbooleanstring

Defaulttrue

Is the path relative to the users home directory

usernamestring

Username on the remote server

Outputs

filesarray

The list of 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

Core Plugins and tasks

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

CoreStorageScript

Resend

Plugin Resend for Kestra

Messaging

MQTT

This sub-group of plugins contains tasks for using a MQTT message broker.

Messaging

list
List files from an FTP server directory.

More Plugins in this Category

Core Plugins and tasks

Resend

MQTT

1.2.0

listList files from an FTP server directory.

More Plugins in this Category

Core Plugins and tasks

Resend

MQTT

1.2.0

list
List files from an FTP server directory.