File system Delete

File system Delete
Certified
Delete a remote FTP file or directory

Removes the specified file or directory on the server. Directory deletion is recursive by default. Defaults: port 21, passive mode on, remote IP verification on, paths relative to user home.

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

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

options

Default

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

FTP client options

Definitions

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

connectionTimeoutstring

DefaultPT30S

Control connection timeout

Maximum time to open the control channel. Default 30s.

controlKeepAliveReplyTimeoutstring

DefaultPT30S

Keep-alive reply timeout

How long to wait for keep-alive responses before failing. Default 30s.

controlKeepAliveTimeoutstring

DefaultPT30S

Control keep-alive interval

Sends keep-alive commands during long transfers. Default 30s.

dataTimeoutstring

DefaultPT30S

Data channel timeout

Maximum time to open the data socket. Default 30s.

socketTimeoutstring

DefaultPT30S

Socket read timeout

Timeout for socket reads and writes once connected. Default 30s.

passiveMode booleanstring

Defaulttrue

Use passive data connections

Passive mode avoids most firewall and NAT issues and is enabled by default (true). Set to false to force active mode.

password string

Password

pluginDefaultsRef string

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

port string

Default21

Remote port

proxyHost string

FTP proxy hostname

proxyPort string

FTP proxy port

proxyType string

Possible Values

DIRECTHTTPSOCKS

FTP proxy type

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.

remoteIpVerification booleanstring

Defaulttrue

Verify data channel IP

Ensures the responding server IP matches the control connection to prevent spoofed data channels.

rootDir booleanstring

Defaulttrue

Treat path as user home root

If true (default), remote paths are resolved relative to the authenticated user's home directory.

username string

Username

Outputs

deleted boolean

Defaultfalse

Whether the file or directory was deleted

uri string

Formaturi

The deleted URI

uris array

SubTypestring

URIs of all deleted files when regExp is used

Liquibase

Tasks that run Liquibase change management commands.

Data

PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Data

File system DeleteCertifiedDelete a remote FTP file or directory

File system Delete

More Plugins in this Category

Liquibase

PostgreSQL

File system Delete
Certified
Delete a remote FTP file or directory