SFTP (SSH File Transfer Protocol) Move

SFTP (SSH File Transfer Protocol) Move

Certified

Move or rename an SFTP file

Moves/renames a remote file; destination directories are created when missing. 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.Move
yaml
id: fs_sftp_move
namespace: company.team

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

Source file or directory URI

Remote host

Destination URI

Full target path. If it ends with /, the source name is kept. Existing targets are replaced when overwrite is true.

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
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.

Defaultfalse

Overwrite existing files

If false (default), fails when the destination already exists.

Passphrase for the SSH key

Password

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.

Username

Formaturi

The from uri

Formaturi

The destination uri

More Plugins in this Category

VMware (EE)
VMware
Enterprise

Tasks that automate VMware vSphere operations within Kestra workflows.

Infrastructure

33 tasks

3 blueprints

Metaplane
Metaplane

Run and read data-observability monitors from Metaplane.

Data

5 tasks

6 blueprints