download

This block is part of the files group and was last modified in core v14.0.1.

download v10.5.10 Updated v14.0.1

download a custom file from a given endpoint

In pins 2 + flow
  • flow
    flow
  • host required
    value

    Could be a FTP or HTTP(s) host. e.g. ftp://username:password@host/file.pdf

  • options
    object

    { timeout: number in seconds, base_auth: { username, password }, bearer_token: value, user_agent: value, headers: object }.

Out pins 4 + flow
  • flow
    flow
  • success
    condition
  • file
    file

    Array of files retrieved from endpoint

  • headers
    object

    HTTP Response Headers

  • error
    value

A typical wiring for download: value feeds the host pin; the flow out pin feeds branch.

Studio canvas example for the download block: typical wiring for download.

Commonly used with

In production blueprints, this block is most often wired together with:

  • branch: this block feeds into it.
  • execute: this block feeds into it. Executes the given funcion and waits for it to be executed.
  • get fields: feeds into this block. Gets the selected fields from the given object.
  • new object: this block feeds into it. Builds a new object filled with the given fields.
  • create: feeds into this block. Creates a new function that can be executed using the given name.

Version history

Introduced in v10.5.10.

Last modified in v14.0.1.


Back to files Return to the main group to view all sub-groups Back to file Return to the group to view all blocks within this group