File system Upload

File system Upload
Certified
Upload a file to FTP

Pushes one local file to the remote path. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home.

yaml
type: io.kestra.plugin.fs.ftp.Upload

Examples

yaml
id: fs_ftp_upload
namespace: company.team

inputs:
  - id: file
    type: FILE

tasks:
  - id: upload
    type: io.kestra.plugin.fs.ftp.Upload
    host: localhost
    port: 21
    username: foo
    password: "{{ secret('FTP_PASSWORD') }}"
    from: "{{ inputs.file }}"
    to: "/upload/dir2/file.txt"

Properties

from *string

Source file (kestra:// URI)

Pebble expression referencing an Internal Storage URI e.g. {{ outputs.mytask.uri }}.

host *string

Remote host

enableSshRsa1 booleanstring

Defaultfalse

Enable the RSA/SHA1 algorithm (disabled by default)

options

Default

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

FTP client options

Definitions

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

connectionTimeoutstring

DefaultPT30S

Control connection timeout

Maximum time to open the control channel. Default 30s.

controlKeepAliveReplyTimeoutstring

DefaultPT30S

Keep-alive reply timeout

How long to wait for keep-alive responses before failing. Default 30s.

controlKeepAliveTimeoutstring

DefaultPT30S

Control keep-alive interval

Sends keep-alive commands during long transfers. Default 30s.

dataTimeoutstring

DefaultPT30S

Data channel timeout

Maximum time to open the data socket. Default 30s.

socketTimeoutstring

DefaultPT30S

Socket read timeout

Timeout for socket reads and writes once connected. Default 30s.

overwrite booleanstring

Defaulttrue

Overwrite existing files

If false, fails when the destination already exists.

passiveMode booleanstring

Defaulttrue

Use passive data connections

Passive mode avoids most firewall and NAT issues and is enabled by default (true). Set to false to force active mode.

password string

Password

pluginDefaultsRef string

Reference (ref) of the pluginDefaults to apply to this task.

port string

Default21

Remote port

proxyHost string

FTP proxy hostname

proxyPort string

FTP proxy port

proxyType string

Possible Values

DIRECTHTTPSOCKS

FTP proxy type

remoteIpVerification booleanstring

Defaulttrue

Verify data channel IP

Ensures the responding server IP matches the control connection to prevent spoofed data channels.

rootDir booleanstring

Defaulttrue

Treat path as user home root

If true (default), remote paths are resolved relative to the authenticated user's home directory.

to string

Destination path

If unset, uses the source filename.

username string

Username

Outputs

from string

Formaturi

The fully-qualified URIs that point to source data

to string

Formaturi

The fully-qualified URIs that point to destination path

Liquibase

Tasks that run Liquibase change management commands.

Data

OPA (Open Policy Agent)

Enterprise

Tasks to manage Open Policy Agent policies and decisions, including upload, evaluation, and partial evaluation.

Infrastructure

File system UploadCertifiedUpload a file to FTP

File system Upload

More Plugins in this Category

Liquibase

OPA (Open Policy Agent)

File system Upload
Certified
Upload a file to FTP