File system Delete
CertifiedDelete a remote SFTP file or directory
File system Delete
Delete a remote SFTP file or directory
Removes the specified file or directory on the server. Directory deletion is recursive by default. Defaults: port 22, user home as root, password auth unless a PEM key is provided, host key checking disabled by default.
type: io.kestra.plugin.fs.sftp.DeleteExamples
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 *string
Remote host
uri *string
URI of the file or directory to delete
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150enableSshRsa1 booleanstring
falseEnable the RSA/SHA1 algorithm (disabled by default)
errorOnMissing booleanstring
falseRaise error if missing
keyExchangeAlgorithm string
Key exchange algorithm
Override the KEX algorithm (e.g. diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256).
keyfile string
SSH private key (PEM)
PEM-formatted private key for public key auth. Convert OpenSSH keys with ssh-keygen -m PEM.
passphrase string
Passphrase for the SSH key
password string
Password
port string
22Remote port
proxyAddress string
SFTP proxy address
proxyPassword string
SFTP proxy password
proxyPort string
SFTP proxy port
proxyType string
SFTP proxy type
One of SOCKS5, STREAM, or HTTP.
proxyUsername string
SFTP proxy username
recursive booleanstring
falseInclude 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.
rootDir booleanstring
trueTreat 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
falseWhether the file or directory was deleted
uri string
uriThe deleted URI
uris array
URIs of all deleted files when regExp is used
