Delete a file from an SFTP server.
type: "io.kestra.plugin.fs.sftp.Delete"Examples
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 *Requiredstring
Hostname of the remote server
uri *Requiredstring
The file to delete
enableSshRsa1 booleanstring
falseEnable the RSA/SHA1 algorithm (disabled by default)
errorOnMissing booleanstring
falseraise an error if the file is not found
keyExchangeAlgorithm string
Configures Key exchange algorithm explicitly e. g diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1.
keyfile string
Private keyfile in the PEM file format to connect to a remote server using SSH
To generate a PEM format key from OpenSSH, use the following command: ssh-keygen -m PEM
passphrase string
Passphrase of the ssh key
password string
Password on the remote server
port string
22Port of the remote server
proxyHost string
SFTP proxy host
proxyPassword string
SFTP proxy password
proxyPort string
SFTP proxy port
proxyType string
SFTP proxy type
proxyUser string
SFTP proxy user
rootDir booleanstring
trueIs the path relative to the users home directory
username string
Username on the remote server
Outputs
deleted boolean
falseIf the files was really deleted
uri string
uriThe deleted uri