PluginsPlugin FsFtps File Transfer Protocol Secure

List

List files from an FTPS server directory.

yaml
type: "io.kestra.plugin.fs.ftps.List"

Examples

yaml
id: fs_ftps_list
namespace: company.team

tasks:
  - id: list
    type: io.kestra.plugin.fs.ftps.List
    host: localhost
    port: 990
    username: foo
    password: "{{ secret('FTPS_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

dataChannelProtectionLevel string

Default P

Possible Values

CSEP

Sets the data channel protection level (PROT).

enableSshRsa1 booleanstring

Default false

Enable the RSA/SHA1 algorithm (disabled by default)

insecureTrustAllCertificates booleanstring

Whether the client should disable checking of the remote SSL certificate.

Note: This makes the SSL connection insecure, and should only be used for testing.

mode string

Default EXPLICIT

Possible Values

IMPLICITEXPLICIT

Sets FTPS mode, either "implicit" or "explicit".

options FtpInterface-Options

Default

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

passiveMode booleanstring

Default true

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.

password string

Password on the remote server

port string

Default 990

Port of the remote server

proxyHost string

FTP proxy host

proxyPort string

FTP proxy port

proxyType string

Possible Values

DIRECTHTTPSOCKS

FTP proxy type

recursive booleanstring

Default false

List file recursively

regExp string

A regexp to filter on full path

remoteIpVerification booleanstring

Default true

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

rootDir booleanstring

Default true

Is the path relative to the users home directory

username string

Username on the remote server

Outputs

files array

SubType

The list of files

Definitions

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

accessDate string

Format date-time

fileType string

Possible Values

FOLDERFILEFILE_OR_FOLDERIMAGINARY

flags integer

groupId integer

name string

path string

Format uri

permissions integer

size integer

symbolicLink boolean

Default false

updatedDate string

Format date-time

userId integer

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

connectionTimeout string

Default PT30S

Format duration

The timeout for the initial control connection.

controlKeepAliveReplyTimeout string

Default PT30S

Format duration

The control keep alive reply timeout.

to ensure the socket be alive after download huge file.

controlKeepAliveTimeout string

Default PT30S

Format duration

the control keep alive timeout.

to ensure the socket be alive after download huge file.

dataTimeout string

Default PT30S

Format duration

The timeout for opening the data channel.

socketTimeout string

Default PT30S

Format duration

The socket timeout.

​List

List