Delete
yaml
type: "io.kestra.plugin.fs.sftp.Delete"
Delete a file to a SFTP server.
Examples
yaml
id: "delete"
type: "io.kestra.plugin.fs.sftp.Delete"
host: localhost
port: 22
username: foo
password: pass
uri: "/upload/dir1/file.txt"
Properties
host
- Type: string
- Dynamic: ✔️
- Required: ✔️
Hostname of the remote server
uri
- Type: string
- Dynamic: ✔️
- Required: ✔️
The file to delete
errorOnMissing
- Type: boolean
- Dynamic: ❌
- Required: ❌
raise an error if the file is not found
keyfile
- Type: string
- Dynamic: ✔️
- Required: ❌
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
- Type: string
- Dynamic: ✔️
- Required: ❌
Passphrase of the ssh key
password
- Type: string
- Dynamic: ✔️
- Required: ❌
Password on the remote server
port
- Type: string
- Dynamic: ✔️
- Required: ❌
- Default:
22
Port of the remote server
proxyHost
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy host
proxyPassword
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy password
proxyPort
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy port
proxyType
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy type
proxyUser
- Type: string
- Dynamic: ✔️
- Required: ❌
SFTP proxy user
rootDir
- Type: boolean
- Dynamic: ✔️
- Required: ❌
- Default:
true
Is path is relative to root dir
username
- Type: string
- Dynamic: ✔️
- Required: ❌
Username on the remote server
Outputs
deleted
- Type: boolean
- Default:
false
If the files was really deleted
uri
- Type: string
The deleted uri