Skip to content
Zoan Docs

Download Storage File

Download Storage File

Section titled “Download Storage File”

Type: storage-download-file  ·  Package: Storage Activities v1.0.5  ·  Output: string

Downloads a file from a bucket in Zoan Cloud Storage to the robot’s disk, to work with it (open it in Excel, attach it to an email, load it into a system). Returns the local path where it was saved.

How it works

Section titled “How it works”
  1. Identifies the file by its id or by bucket + name. If you set id, bucket and name are ignored.
  2. Asks Zoan Cloud for a temporary download link and downloads the file to destination.
  3. Creates any missing folders in destination. If a file already exists at that path, it is overwritten.

If the bucket has download auditing enabled, the read is recorded.

Required parameters

Section titled “Required parameters”
ParameterTypeDefaultDescription
destinationstring—Local path where the file is saved, including its name. E.g.: C:/work/sales.xlsx.

In addition, you must set id or name (see optional parameters).

Optional parameters

Section titled “Optional parameters”
ParameterTypeDefaultDescription
idstring—File id (alternative to bucket + name).
namestring—File name inside the bucket, including its folders. E.g.: 2026/sales.xlsx.
bucketstring"default"Bucket name. Only used with name.

Output

Section titled “Output”

Returns a string with the local path of the downloaded file (the same value as destination). If the file doesn’t exist, the activity fails: it doesn’t return an empty path.

Common errors

Section titled “Common errors”
MessageCause and fix
'destination' is required.You didn’t set destination.
Provide 'id' or 'name'.You set neither id nor name.
… HTTP 404: …File not found in this environment.There’s no file with that id or that bucket + name in the environment where the robot runs (names are case-sensitive and include folders). Check the reference with List Storage Files.
… HTTP 400: …Invalid bucket name…The bucket name has characters that aren’t allowed.
Download failed: HTTP {code}.Downloading the temporary link failed (network, proxy). Retry with Retry.
Storage activities require a Zoan Cloud runtime context. Missing: …The process isn’t running from Zoan Cloud or from the Designer signed in.

Errors arrive with the prefix “Could not download the file: ”. An error writing to destination (invalid path, no permissions, file open in another program) also makes the activity fail.

Example

Section titled “Example”
Download Storage File   bucket = "reports"   name = "2026/sales.xlsx"
                        destination = "C:/work/sales.xlsx"   → output: path
Read Excel Sheet        path = path   hasHeader = true   → output: sales
Section titled “Related activities”