Delete a file from an FTP server.

yaml
type: "io.kestra.plugin.fs.ftp.delete"

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: "{{ secret('FTP_PASSWORD') }}"
    uri: "/upload/dir1/file.txt"

Properties

host *string

Hostname of the remote server

uri *string

The file to delete

enableSshRsa1 booleanstring

Default false

Enable the RSA/SHA1 algorithm (disabled by default)

errorOnMissing booleanstring

Default false

raise an error if the file is not found

options FtpInterface-Options

Default

{
  "connectionTimeout": "PT30S",
  "dataTimeout": "PT30S",
  "socketTimeout": "PT30S",
  "controlKeepAliveTimeout": "PT30S",
  "controlKeepAliveReplyTimeout": "PT30S"
}

passiveMode booleanstring

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 string

Password on the remote server

port string

Default 21

Port of the remote server

proxyHost string

FTP proxy host

proxyPort string

FTP proxy port

proxyType string

Possible Values

DIRECTHTTPSOCKS

FTP proxy type

remoteIpVerification booleanstring

Default true

Control that the server ip that emit the request is the same than send response.

rootDir booleanstring

Default true

Is the path relative to the users home directory

username string

Username on the remote server

Outputs

deleted boolean

Default false

If the files was really deleted

uri string

Format uri

The deleted uri

Definitions

io.kestra.plugin.fs.ftp.FtpInterface-Options

connectionTimeout string

Default PT30S

Format duration

The timeout for the initial control connection.

controlKeepAliveReplyTimeout string

Default PT30S

Format duration

The control keep alive reply timeout.

to ensure the socket be alive after download huge file.

controlKeepAliveTimeout string

Default PT30S

Format duration

the control keep alive timeout.

to ensure the socket be alive after download huge file.

dataTimeout string

Default PT30S

Format duration

The timeout for opening the data channel.

socketTimeout string

Default PT30S

Format duration

The socket timeout.