Download FTP with YAML

YAML parameters for Download FTP

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to DOWNLOAD_FTP.
source_path
Required
StringThe path from which the file will be downloaded.
destination_path
Required
StringThe path in which the file will be saved.
host
Required
StringThe host for the connection.
login
Required
StringThe username required to connect to the server.
port
Required
StringThe port for the connection.
password
Required
StringThe password required to connect to the server.
overwriteBooleanReplace files if they already exist.
recursiveBooleanIf set to true, the whole directory tree is downloaded, otherwise only the files from the path are downloaded.
download_excludesString[]The paths and/or files that will be left out during the download.
download_includesString[]The exceptions from the ignore patterns set in download_excludes.

YAML example for Download FTP

actions:
- action: "Download files from $host"
  type: "DOWNLOAD_FTP"
  source_path: "source"
  destination_path: "destination"
  login: "username"
  password: "secure!R6gJWacVUBuxvJiNxu4hUQ=="
  host: "$host"
  port: "21"
  download_excludes:
  - "/tmp"
  - "*.log"
  download_includes:
  - "/tmp/assets"
  - "/tmp/styles"

Last modified on April 26, 2022

Get Started

Sign up for free and deploy your project in less than 10 minutes.