File system Delete

File system Delete
Certified
Delete a remote SFTP file or directory

Removes the specified file or directory on the server. Directory deletion is recursive by default. 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.Delete

Examples

yaml
id: fs_sftp_delete
namespace: company.team

tasks:
  - id: delete
    type: io.kestra.plugin.fs.sftp.Delete
    host: localhost
    port: "22"
    username: foo
    password: "{{ secret('SFTP_PASSWORD') }}"
    uri: "/upload/dir1/file.txt"

Properties

host *string

Remote host

uri *string

URI of the file or directory to delete

enableSshRsa1 booleanstring

Defaultfalse

Enable the RSA/SHA1 algorithm (disabled by default)

errorOnMissing booleanstring

Defaultfalse

Raise error if missing

keyExchangeAlgorithm string

Key exchange algorithm

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

keyfile string

SSH private key (PEM)

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

passphrase string

Passphrase for the SSH key

password string

Password

pluginDefaultsRef string

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

port string

Default22

Remote port

proxyAddress string

SFTP proxy address

proxyPassword string

SFTP proxy password

proxyPort string

SFTP proxy port

proxyType string

SFTP proxy type

One of SOCKS5, STREAM, or HTTP.

proxyUsername string

SFTP proxy username

recursive booleanstring

Defaultfalse

Include subdirectories

If true, deletes directory contents recursively.

regExp string

A regular expression to filter files for deletion

When set, uri must point to a directory. The pattern is matched against the path component of the remote URI (for example, /remote/dir/file.csv). Only regular files are deleted; directories are skipped.