Delete
yaml
type: "io.kestra.plugin.fs.ftp.Delete"
Delete a file to a FTP server.
Examples
yaml
id: fs_ftp_delete
namespace: company.team
tasks:
- id: delete
type: io.kestra.plugin.fs.ftp.Delete
host: localhost
port: 21
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: ❌
- Default:
false
raise an error if the file is not found
passiveMode
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
true
Whether to use a passive mode. Passive mode is generally considered more secure as it's less likely to encounter issues with NAT and firewalls. Therefore, this property is by default set to true
. To use active mode instead, set the property to false
.
password
- Type: string
- Dynamic: ✔️
- Required: ❌
Password on the remote server
port
- Type: string
- Dynamic: ✔️
- Required: ❌
- Default:
21
Port of the remote server
proxyHost
- Type: string
- Dynamic: ✔️
- Required: ❌
FTP proxy host
proxyPort
- Type: string
- Dynamic: ✔️
- Required: ❌
FTP proxy port
proxyType
- Type: string
- Dynamic: ✔️
- Required: ❌
- Possible Values:
DIRECT
HTTP
SOCKS
FTP proxy type
remoteIpVerification
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
true
Control that the server ip that emit the request is the same than send response.
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
- Required: ❌
- Default:
false
If the files was really deleted
uri
- Type: string
- Required: ❌
- Format:
uri
The deleted uri
Definitions
Was this page helpful?