Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for Download

View as Markdown

Download files from remote servers via transfer targets.

YAML parameters for Download

PARAMETERS
targetsrequiredobject[]
The list of target servers for file transfer.
typerequiredstring

Value: DOWNLOAD

actionrequiredstring
Unique identifier for the action within the pipeline.
source_pathstring
The path to the source file or directory to download
destination_pathstring
The path where the downloaded files will be saved
recursiveboolean
If set to true, directories will be downloaded recursively
overwriteboolean
If set to true, existing files will be overwritten
download_excludesstring[]
The list of files or directories to exclude from download
download_includesstring[]
The list of files or directories to include in download
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.
run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Apr 27, 2026

Previous pageDockerfile LinterNext pageDownload Artifact Version

YAML examples for Download

Download files from server

yaml
  - action: "Download files from server"
    type: "DOWNLOAD"
    source_path: "/var/www/backups"
    destination_path: "/local/backups"
    recursive: true
    overwrite: true
    targets:
      - target: backup-server
        type: SSH
        host: backup.example.com
        port: 22
        auth:
        method: PASSWORD
        username: backup_user
        password: $BACKUP_PASSWORD

Simple file download

yaml
  - action: "Download files"
    type: "DOWNLOAD"
    source_path: "Home/www"
    targets:
      - target: server
        type: SSH
        host: example.com
        auth:
        method: PASSWORD
        username: user

Download files via FTP/FTPS

yaml
  - action: "Download files via FTPS"
    type: "DOWNLOAD"
    source_path: "Home/www"
    destination_path: /
    download_excludes:
      - /tmp
      - '*.log'
    download_includes:
      - /tmp/assets
      - /tmp/styles
    targets:
      - target: ftp_server
        type: FTP
        secure: true
        host: ftp.example.com
        auth:
        username: ftp_user
        password: $FTP_PASSWORD