ftp_download

Downloads file from ftp. Must be used inside {% ftp_session %} {% endftp_session %}.

Accepts:

  • from - path to the file on remove server

Result is saved in a variable that follows as keyword.

Result has following format:

{
    "ok": true, 
    "error": null, // null only when ok: true
    "file": {
        "name": "test.csv",
        "public": false
    }
}

Below example downloads file from /outgoing/test.csv on a remote ftp server.

{% comment %}FTP configuration{% endcomment %}
{% liquid 
  assign host = "[email protected]"
  assign user = "user"
  assign password = "password"
  assign port = 21
  assign sftp = false
  assign path = "/outgoing/test.csv"
%}

{% ftp_session host:host, user:user, password:password, port:port, sftp:sftp %}
  {% ftp_download from:file.path as download_result %}
  {% if download_result.ok %}
    {% log "File successfully downloaded!" %}
  {% else %}
    {% log download_result.error %}
  {% endif %}
{% endftp_session %}

Last updated