File system Downloads

File system Downloads

Certified

Download multiple local files

Lists files within allowed-paths, downloads up to maxFiles (default 25) to Kestra storage, then optionally MOVE or DELETE them. Local access requires configured allowed-paths; moveDirectory is required when action is MOVE.

Example (Kestra config):

plugins: 
  configurations: 
    - type: io.kestra.plugin.fs.local.Downloads
      values: 
        allowed-paths: 
          - /data/files
yaml
type: io.kestra.plugin.fs.local.Downloads
yaml
id: fs_local_downloads
namespace: company.team

tasks:
  - id: downloads
    type: io.kestra.plugin.fs.local.Downloads
    from: "/data/files/"
    regExp: ".*.csv"
    recursive: true
    action: NONE

yaml
id: fs_local_downloads_move
namespace: company.team

tasks:
  - id: downloads_move
    type: io.kestra.plugin.fs.local.Downloads
    from: /data/files/
    regExp: ".*.csv"
    recursive: true
    action: MOVE
    moveDirectory: "/data/archive"
Properties

Directory to list

DefaultNONE
Possible Values
MOVEDELETENONE

Action on downloaded files

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.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset 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.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
Default25

Maximum files to retrieve

Destination directory when action is MOVE

Defaultfalse

List files recursively

Regexp filter on full path

Metadata of downloaded files

Definitions
accessedDatestring
Formatdate-time
createdDatestring
Formatdate-time
isDirectoryboolean
localPath
modifiedDatestring
Formatdate-time
namestring
parentstring
sizeinteger
uristring
Formaturi
SubTypestring

The downloaded files formatted as a map of from/to URIs