List

type: "io.kestra.plugin.fs.ftp.List"

List files from FTP server directory

Examples

id: fs_ftp_list
namespace: company.team

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

Properties

from

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

The fully-qualified URIs that point to path

host

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

Hostname of the remote server

passiveMode

• Type: boolean
• Dynamic: ❌
• Required: ❌
• 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

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

Password on the remote server

port

• Type: string
• Dynamic: ✔️
• Required: ❌
• Default: 21

Port of the remote server

proxyHost

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

FTP proxy host

proxyPort

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

FTP proxy port

proxyType

• Type: string
• Dynamic: ✔️
• Required: ❌
• Possible Values:
  • DIRECT
  • HTTP
  • SOCKS

FTP proxy type

recursive

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

List file recursively

regExp

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

A regexp to filter on full path

remoteIpVerification

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: true

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

rootDir

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: true

Is the path relative to the users home directory

username

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

Username on the remote server

Outputs

files

• Type: array
• SubType: File
• Required: ❌

The list of files

Definitions

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

Properties

accessDate

• Type: string
• Dynamic: ❓
• Required: ❓
• Format: date-time

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: ❓
• Format: uri

permissions

• Type: integer
• Dynamic: ❓
• Required: ❓

size

• Type: integer
• Dynamic: ❓
• Required: ❓

symbolicLink

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

updatedDate

• Type: string
• Dynamic: ❓
• Required: ❓
• Format: date-time

userId

• Type: integer
• Dynamic: ❓
• Required: ❓