File system List
CertifiedList files in an SFTP directory
File system List
List files in an SFTP directory
Lists entries under the given path with optional regexp filter. Sorted with sort (default NONE) before maxFiles truncation. 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.ListExamples
id: fs_sftp_list
namespace: company.team
tasks:
- id: list
type: io.kestra.plugin.fs.sftp.List
host: localhost
port: "22"
username: foo
password: "{{ secret('SFTP_PASSWORD') }}"
from: "/upload/dir1/"
regExp: '.*/dir1/.*\.(yaml|yml)'
sort: NAME_ASC
Properties
from *string
Directory URI to list
host *string
Remote host
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)
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.
maxFiles integerstring
25Maximum files to retrieve
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
falseList files recursively
regExp string
Regexp filter on full path
rootDir booleanstring
trueTreat path as user home root
If true (default), remote paths are resolved relative to the authenticated user's home directory.
sort string
NONENONELAST_MODIFIED_ASCLAST_MODIFIED_DESCNAME_ASCNAME_DESCSort order applied to the list before maxFiles truncation
NONE (default) preserves the order in which the server returns files. LAST_MODIFIED_ASC/LAST_MODIFIED_DESC sort by last modified date, oldest/newest first. NAME_ASC/NAME_DESC sort alphabetically by file name.
username string
Username
Outputs
files array
The list of files
io.kestra.plugin.fs.vfs.models.File
date-timeFOLDERFILEFILE_OR_FOLDERIMAGINARYurifalsedate-time
