File system Upload

File system Upload

Certified

Upload a file via SFTP

Pushes one local file to the remote path. Defaults: port 22, user home as root, password auth unless a PEM key is provided, host key checking disabled by default.

yaml
type: io.kestra.plugin.fs.sftp.Upload
yaml
id: fs_sftp_upload
namespace: company.team

inputs:
  - id: file
    type: FILE

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

Source file (kestra:// URI)

Remote host

Defaultfalse

Enable the RSA/SHA1 algorithm (disabled by default)

Key exchange algorithm

Override the KEX algorithm (e.g. diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256).

SSH private key (PEM)

PEM-formatted private key for public key auth. Convert OpenSSH keys with ssh-keygen -m PEM.

Defaulttrue

Overwrite existing files

If false, fails when the destination already exists.

Passphrase for the SSH key

Password

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

Default22

Remote port

SFTP proxy address

SFTP proxy password

SFTP proxy port

SFTP proxy type

One of SOCKS5, STREAM, or HTTP.

SFTP proxy username

Defaulttrue

Treat path as user home root

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

Destination path

If unset, uses the source filename.

Username

Formaturi

The fully-qualified URIs that point to source data

Formaturi

The fully-qualified URIs that point to destination path