Trigger a flow as soon as new files are detected in a given FTPS server's directory.

Wait for one or more files in a given FTPS server's directory and process each of these files sequentially.

yaml
id: ftps_trigger_flow
namespace: company.team

tasks:
  - id: for_each_file
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.files }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value | jq('.path') }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.ftps.Trigger
    host: localhost
    port: 990
    username: foo
    password: bar
    from: "/in/"
    interval: PT10S
    action: MOVE
    moveDirectory: "/archive/"

Wait for one or more files in a given FTPS server's directory and process each of these files sequentially. In this example, we restrict the trigger to only wait for CSV files in the mydir directory.

yaml
id: ftp_wait_for_csv_in_mydir
namespace: company.team

tasks:
  - id: each
    type: io.kestra.plugin.core.flow.ForEach
    values: "{{ trigger.files }}"
    tasks:
      - id: return
        type: io.kestra.plugin.core.debug.Return
        format: "{{ taskrun.value | jq('.path') }}"

triggers:
  - id: watch
    type: io.kestra.plugin.fs.ftps.Trigger
    host: localhost
    port: "21"
    username: foo
    password: bar
    from: "mydir/"
    regExp: ".*.csv"
    action: MOVE
    moveDirectory: "archive/"
    interval: PTS

Possible Values

MOVEDELETENONE

The action to perform on the retrieved files. If using 'NONE' make sure to handle the files inside your flow to avoid infinite triggering.

The directory to list

Hostname of the remote server

SubType

List of conditions in order to limit the flow trigger.

Default P

Possible Values

CSEP

Sets the data channel protection level (PROT).

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.

Default 60

Format duration

The interval between test of triggers

Default EXPLICIT

Possible Values

IMPLICITEXPLICIT

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

The destination directory in case off MOVE

Default

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

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 on the remote server

Default 990

Port of the remote server

FTP proxy host

FTP proxy port

Possible Values

DIRECTHTTPSOCKS

FTP proxy type

Default false

List file recursively

A regexp to filter on full path

Default true

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

Default true

Is the path relative to the users home directory

SubType string

Possible Values

CREATEDRUNNINGPAUSEDRESTARTEDKILLINGSUCCESSWARNINGFAILEDKILLEDCANCELLEDQUEUEDRETRYINGRETRIEDSKIPPED

List of execution states after which a trigger should be stopped (a.k.a. disabled).

Username on the remote server

SubType

Metadata of downloaded files.

SubType string

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

Format date-time

Possible Values

FOLDERFILEFILE_OR_FOLDERIMAGINARY

Format uri

Default false

Format date-time

Default PT30S

Format duration

The timeout for the initial control connection.

Default PT30S

Format duration

The control keep alive reply timeout.

to ensure the socket be alive after download huge file.

Default PT30S

Format duration

the control keep alive timeout.

to ensure the socket be alive after download huge file.

Default PT30S

Format duration

The timeout for opening the data channel.

Default PT30S

Format duration

The socket timeout.