File system Download

File system Download

Certified

Download local file to internal storage

Copies a local file (within configured allowed-paths) into Kestra internal storage. Fails if the source is missing; preserves size and file extension when possible. Local access requires allowed-paths in plugin defaults.

Example (Kestra config):

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

tasks:
  - id: download
    type: io.kestra.plugin.fs.local.Download
    from: "/data/files/source.csv"
    workerGroup: "etl-worker"

Download a local file and fail if its SHA-256 checksum does not match

yaml
id: fs_local_download_checksum
namespace: company.team

tasks:
  - id: download
    type: io.kestra.plugin.fs.local.Download
    from: "/data/files/source.csv"
    validateChecksum: true
    checksumExpected: "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
Properties

Source file path

Absolute local path of the file to download

DefaultSHA_256
Possible Values
MD5SHA_1SHA_256SHA_512

Checksum algorithm to use

Defaults to SHA_256. The computed checksum is always exposed on the output as checksum. MD5 and SHA_1 are deprecated and considered weak; prefer SHA_256 or SHA_512.

Expected checksum value to compare against the downloaded file

Required when validateChecksum is true. Comparison is case-insensitive.

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

Defaultfalse

Validate the downloaded file against an expected checksum

When enabled, the task fails if the computed checksum does not match checksumExpected. The downloaded file is not stored in internal storage if validation fails.

Checksum of the downloaded file

Hex-encoded digest computed with checksumAlgorithm. Populated whenever the file is downloaded successfully.

Size of the downloaded file in bytes

Formaturi

URI of the file in Kestra storage