Download

YAML parameters

Name Type Description
action Required String The ID of the action.
type Required String The type of the action. Should be set to DOWNLOAD.
targets Required Target[] Defines a target (server) for your deployments using the following parameters.
source_path String The path in the repository.
recursive Boolean If set to true, the whole directory tree is downloaded, otherwise only the files from the path are downloaded.
overwrite Boolean Replace files if they already exist.
destination_path String The absolute or relative path on the remote server.
download_excludes String[] The paths and/or files that will be left out during the download.
download_includes String[] The exceptions from the ignore patterns set in download_excludes.

Parameters for targets

Name Type Description
target Required String Target identifier
type Required String The type of the target. Possible values: FTP, SSH, MATCH, UPCLOUD, VULTR, DIGITAL_OCEAN
host Required String The host for the connection
auth Required Auth Authentication details using the following parameters.
path String Path on the server defined in the target.
port String Port for the connection
secure Boolean For Download FTP type only. Determines whether the transfer is FTP or FTPS. A value of true will set it to FTPS, while false will set it to FTP.
proxy Proxy Define a SSH proxy server using the following parameters (available only for SSH targets).

Parameters for auth in targets

Name Type Description
method Required String Required for SSH, UPCLOUD, VULTR and DIGITAL_OCEAN. Defines authentication method, available values: PASSWORD, SSH_KEY, ASSETS_KEY, PROXY_CREDENTIALS, PROXY_KEY
username Required String The username required to connect to the server.
password String The password required to connect to the server. Required for PASSWORD method.
asset String Name of the variable containing the private key. Required for ASSETS_KEY method.
passphrase String Passphrase for the SSH key.
key String Proxy key used for authentication. For proxy targets only.
key_path String Path to the key on proxy server. Required for method PROXY_KEY.

Parameters for proxy

Name Type Description
host String Host for the proxy connection.
port String The port for the proxy connection.
auth Auth Define proxy servers' authentication method using the following parameters.

Examples

Download FTP/FTPS

yaml
actions: - action: Download files from $host type: DOWNLOAD source_path: Home/www targets: - target: host type: FTP secure: true host: $host auth: username: username password: secure!7P9rKHgeuzRvvHFz3Heentqh5nD4saaZnoeIM6VKqJo=.bfjzY4DPq5a3UzSpNhT1wg== destination_path: / download_excludes: - /tmp - '*.log' download_includes: - /tmp/assets - /tmp/styles

Download SFTP (Password)

yaml
actions: - action: Download files from $host type: DOWNLOAD source_path: Home/www recursive: true targets: - target: host type: SSH host: $host auth: username: username password: secure!dBBd4QQ7zI3h+FDbjVS8sig51z16qnWoiroee51G1XU=.6tmg5PO1WlOMg1buwH8CzA== overwrite: true destination_path: / download_excludes: - /tmp - '*.log' download_includes: - /tmp/assets - /tmp/styles

Download SFTP (Key & Password)

yaml
actions: - action: Download files from $host type: DOWNLOAD source_path: Home/www recursive: true targets: - target: host type: SSH host: $host auth: method: ASSETS_KEY username: username password: secure!q/uKT+5eEf80meg8It/a+xfSHDZ71ObVfifN0FbDHjM=.hSVqGQAJ010V1CrkjVGzEg== asset: secure!YvhFlwSQj1iuWIIFnhNjgA== passphrase: secure!kDagtP0/3SrLZF72i0cV6NtrkqBskXWiUq9WsSyMHU4=.UNZ8DZyVnuwWTGxIeSw5Kg== overwrite: true destination_path: / download_excludes: - /tmp - '*.log' download_includes: - /tmp/assets - /tmp/styles

Download SFTP (Private Key & Password)

yaml
actions: - action: Download files from $host type: DOWNLOAD source_path: Home/www recursive: true targets: - target: host type: SSH host: $host auth: method: SSH_KEY username: username password: secure!q/uKT+5eEf80meg8It/a+xfSHDZ71ObVfifN0FbDHjM=.hSVqGQAJ010V1CrkjVGzEg== passphrase: secure!kDagtP0/3SrLZF72i0cV6NtrkqBskXWiUq9WsSyMHU4=.UNZ8DZyVnuwWTGxIeSw5Kg== key: secure!c4pTmKIrHW463c2b0wnkca3yL22Ct3xIqFP/wr66Gk37R267Obf9ZJLC2EZ16jmW7tuHFWstR9WkGaf5opRUp4mz70Tchk9BKzWi5Q+FnQX7alE0D1WrQ7X9Tbz/itSjbCQXU6Z4vu3FysRrbiuvY9W0vUcUxXbROBl99U2wowKSWL1aXN2TPpAgjYTDDgGCeK2IGJLkJ6p2MYOX2i87TyOLNoHK0FRFN8ty4JcRf45aWHCkss1JySCs+C7BN2zAk0d0NLnYh58dLO/qZMt/TLL0/4Tk3OKmvDFW5ODPu4kP+XpDryH8jQC7y8Td/CFCzvDNosO4gb5LlU0DiSmXduYVawZqiPpul8Wq1LqY/dVwr2YlQf+53gxRBr3GUdVyEP+SmegGwcNdo3jHbFLhSpxuHnuU24h8/8R6+w/ZgDRX2gn9nXqdsos0wDSWduNWQH6iATqz0x2k2QbsNXu+h6SDPf83mH50Dx0DRIcQ0juLSFCMOA7VqwTnezhfOzehBYV96N4YJOGR5qKEyuYqFSoYHOCzRV2iWR61W0tYEPsx94HwTc9I/wGvjxPIKUu43QpJSYPLUzBn34YI4USg5MG1ewcBXgadHdQvJhkLyge0k8DNNEYr612kSSYmNfe1DsXxpzbnR+dentu/qVI19HmY5aorJcd9KdGQROPQSyCsi48iYWh9vS3tfTC/ioIiaTItn6BZDQr4uzpFITkjXUadh7QunoRMJAJManlOI9EkRLnEMJVbx85CSf8caJs9fNnhBw6dqhDoR8Lm/oNAn8LPzS6Qw7fJa5BsCNLQ9ityn4RN4HDWUMRkxvFoaItqnJnN5oK7O7PKdGLh/we7q2tgjZQqzPJZH5/2bfdK1/nM3CRYSQtPSlyPymJoePJdy+9qTyfpnwXpijUtMhzOexoYm0t1s6gkYu0G+rpYGJJ+7MnXHlGEVzF3+t6YfOxWP2BxVId5pZP+X9DbhIJyHDLzEzatdV4dK+Ego2Edo2hLCBHMOZcsOWe+dhVcC0mohPw4hANgjSLqkDNUwnNWITC1nbnoE7Rm9CR2pUduG2UpdYSZNkK2KgdpkixeydHh8phO9JfUN7TbtK9N79U6yVKKmwq+6oPASBh9rQuG7pL5JS7yZ3cfx3dtfzuaCGdIUzKcGBEh4wGoPBHdZ1bq9vkKfq9qzVJHGtwG/JW/lKN6v04mIst6eaodayBiT3tH68dsGaoQRF1fgyeIC6GytzqIbAfx/i7SENK6VLyvVBij/Q6OM2RqEigUAktXlmbN7fk9XRu/03/rx5Cl10K/pX66Cd2EbYBjn3M5M76g9p6S2KqfcEMgbFqGYlG4+3dz/DiNalT3e0rT2wEGxK0IQ7hmYiMSwoWLU5ZQNL6D8jjzFi1kt/K1Y/genQ++9rpFZ3U8iz1CIf2/rf84L+hlZVe9UQ05Aqj1Ijoxzl3cDthrEecIr28Z983T0nSQxIICirvOQncFpctwtd4xg8EJ7nCn8scvX5nk6O8RHMRPdvb1TXO8BhCSTj3bZgmUvxhEAhBly2l1G9ev+kNS+0HJxQFENRWJ9AirMUzf6ScAMXs9lrhb+yhzNvpIJe017ulAhSVmHaMyVU6MMZJAU+IQ+10XWbCv92A5EASDa15e7GhxIYe6pqLXHkcvktYKcMtp5OQkjbAzcqdkmfwythk3xlc5A4py5ADt8F1tgktRqcY+ziJxp/5rzL1n3FUVqnErM63jYop5mQ0obXFYbKIVpkdoAfxKXyoUprGilvogW/wtAmD6c7kSV+k6FdD9t5WICJ0otmuwPNwuaJXuczJg3AgAbsILn4Y83ZRMhVjixNFMKasFtWnpv0EFhG6mlBhXm+D34MiqJIa1YI9jFPm+jFEBAZk/4t+mTvgeQwBPlnFXuft7CYb3+bxWN/nZiV042NR/z64w/JMYj/T51aMEiE1GSFusxPmjDhio/k3E4K7og65AO2e+knOnOX4xZp3SyxgWhtS3X4vozgiTlY779urFofJ9ZB/BJYmUuye8DIWkGVO2xdWFuqWREaYg4pCQJpvxuWqaVncUqpBC7rj6uOIrJP0U7a+qLjaVVw0P2vzYb+UjzFMsn8z55RZ25da8+oJa30X+KXx7BGkk51ZblYFlCFCozLSXOHsd/haPxhAC9VYk44D7QIS1tR5ndQmocWNimxnXUvmOExNC61NjMNasXbkTDaJqSzPAZKyzuuYEAlBBR0NFsWdlLdNPWhA5Bh32oq1oRtpXxzawwgE+KpuPO+1q4k7X9e1x8noab1tbOiQbMHf2d819HE2ViEdoEJDRNz2o01yRQihhQTNRpgJ+WYzkMQvVM/xQKvtE+FojEzott5NoCp7cKeWmAEwi+ncmYIinXaDCBvlLgWB7/ZNTVCuWNJ65rJsuhhBATQIz33+WCZ64D9C2jAlLRoGRjRK6QMfVDOejmifI+xSjTIDFw5Sbh5wO5frRvbWpM2D3hKPwyDRJPmMBAv+3ScJ+sCT23HTuuW1u8uf7aKigDlrDJu+TCVXRuX7j/dPGI+QzX9CUofdatMUWTa5Yz9bAvHcIuAzs1Oi3c6tMukfk3maRRhvNuN3Oc6bIrnSUKrUL8kspsulue7yoYcEP54L2uffbCJ0tK/YG9w/aChHYKpjr59VxklESPBPcQxDvGyZNXM6PIbTqPTQuL4+PUyg9BMRjcTD08faJgmkx4oFbuZokGWBYBT4FBr0ItOhi/86SMHmZQLt2vsyVKWPg+d8YYvrnv66Md9fePnQrougMKwDF9/LbrN+TW9fqNWghcoiKG2Gq8KK0YNhNeJyCltTNbuCev8LytGMOAAl7Zlt+NKOLlTxucP53stwKazat2NNOPLNl5sP8oVFqvH44wbdBdW7MVifwlGEvpcmz538iEz/Rwkwka0OD33hSI/Ioq7Bhsw/NCBhTYpG3KLfxxYiZuJEgeBVOHwjbcWZveXC7JHJzNy9lIucppt2SMOKTM6KsyXA2gwNCesoeUyt2dOeISux8FTgqo2jrRO1a3/1VzjGKHydele1X61U/fap2BFycYCTWiEGIoj6VqBFi4u4F/mGK8lf1AmUqhNOl6NsX7i+J8j2wxWrWbItkH0QYYkmkPJzk7WFmo72V62f163Uu+1UFCltM6L+vK/E0y/eCjurr44LH/j67H1IwjE61W6HTNoyUW7EWvW4B9PUoAiUjG19U48LHEBmKDp1RIUcoJkIH4nGiP3RIb57G69xVXrgLzUBmV6PEJw+lgn1+UfMNQyuw8L2YAIe0UoWrfca7zw==.g2m+mFoNBQKL+LmXtKKXXw== overwrite: true destination_path: / download_excludes: - /tmp - '*.log' download_includes: - /tmp/assets - /tmp/styles

SSH target with integration

yaml
- action: Transfer files to DigitalOcean type: DOWNLOAD commands: - date >> tmp.log targets: - target: do_server type: DIGITAL_OCEAN host: buddy-tests port: 6464 path: Home/www auth: username: api_tests_user password: secure!uchZuIWmlFo8df6U1x2p6e3kBdA7ozI3g4I3AmWwl5cRxdqO/lNuZKWF8EF5canJkH0H0CaEaxTjtofe29Zxig==.ugTqbpIDsFqX+EirkR5RZQ== integration: digitalocean run_as_script: true

Proxy

yaml
actions: - action: Upload files to localhost with proxy type: DOWNLOAD local_path: / remote_path: Home/www use_temporary_files: true deployment_excludes: - /assets - file.txt deployment_includes: - /assets/assets-new/ - /assets/file.txt targets: - target: sftp type: SSH host: 192.0.2.1 path: Home/proxy/ auth: username: api_tests_user password: secure!du27Zc5MW1DRv7NfilTtAQ==.0GzkmyRlOlCTPk6MY1veWQ== proxy: host: proxy.myserver.com port: 80 auth: username: api_tests_user_proxy password: secure!vq+DMivrKXUUaLwPU4GrgA==.4jnsl8kzHILdYwJPY2T5rg==

Proxy Password

yaml
proxy: host: 192.0.2.1 port: 4444 auth: username: api_tests_user_proxy password: secure!Dyzh9UQU9RwWbPx3ZWUs5g==.S04TxgmIzIE++wXtjk9bIw==

Proxy Private Key

yaml
proxy: host: 192.0.2.1 port: 4444 auth: method: SSH_KEY username: api_tests_user_proxy password: secure!BodarDz0YQsb6OLwDXl8pA==.2CoOf7LKRBfq5JhF1rc2OQ== asset: "" passphrase: secure!BodarDz0YQsb6OLwDXl8pA==.2CoOf7LKRBfq5JhF1rc2OQ== key: secure!y47qRgV6G1Kocnu/9BKC9IUuQzQ5LgqxPFzt9dZEeeB+6rCrC4O8c+KWh01sq74icrjlHkpAKG3GFra/425VZ2La24HSylpra3S2fsKzU4uivrXyVLOcz1sPRqjjki+WRERhcqLwSDWCfjjY24Zv91Y3/JysYi5FEXUWjWw8jWlT9M4LhtvkvVfnLlMPyvcWbldS6BxmOFE9EN91XzoI1ERJAgkiHsQZHTaCYC0REQ8Z2G/bboOfvArGUN4wi/ws9t30dVQCCP7o6g8BSISI24MCAp7z7k9inSp01XVYegXT6Obi7FbtP6VbAadZSDDSjAlGortNsoKhzKN3ozfxgKQm6yELCza6ALY4Vl5z4dy0OMHJ/M9uzR6bTmahO9e58Sm6t4Jj7YJM4JvtZd/9t9TLmri+yzpd7VTytqfKqiiIQVaWTVQvVoUazpMheMYFNXeSQS+sZsAVTZ17zYD2b+db4YCuA0LFA2yYuslz/xXUv9KmMBY1kht/43LuPiXBJf+FssisXVG8rFxLNqcHQodroYfevSAHU56r1FEFo/xs9RMVGHcto+qLlZTLMqDJbahmuTLR58xtWAxyxCkn+0lK87tPbBWVkSky0+u1SJD6VuGObCZsBJ6fCZh2irEueVXCVy6PcpRyaQ/fVS4d/Q==.DXb7SF0uh23sbZwbZtkIyw==

Proxy Private Key and Password

yaml
proxy: host: 192.0.2.1 port: 4444 auth: method: SSH_KEY username: api_tests_user_proxy password: secure!J8YfygR6RWa9aSJpsy1uMQ==.FnyJtNxL07nQJOWAdkrBiw== passphrase: secure!BodarDz0YQsb6OLwDXl8pA==.2CoOf7LKRBfq5JhF1rc2OQ== key: secure!y47qRgV6G1Kocnu/9BKC9IUuQzQ5LgqxPFzt9dZEeeB+6rCrC4O8c+KWh01sq74icrjlHkpAKG3GFra/425VZ2La24HSylpra3S2fsKzU4uivrXyVLOcz1sPRqjjki+WRERhcqLwSDWCfjjY24Zv91Y3/JysYi5FEXUWjWw8jWlT9M4LhtvkvVfnLlMPyvcWbldS6BxmOFE9EN91XzoI1ERJAgkiHsQZHTaCYC0REQ8Z2G/bboOfvArGUN4wi/ws9t30dVQCCP7o6g8BSISI24MCAp7z7k9inSp01XVYegXT6Obi7FbtP6VbAadZSDDSjAlGortNsoKhzKN3ozfxgKQm6yELCza6ALY4Vl5z4dy0OMHJ/M9uzR6bTmahO9e58Sm6t4Jj7YJM4JvtZd/9t9TLmri+yzpd7VTytqfKqiiIQVaWTVQvVoUazpMheMYFNXeSQS+sZsAVTZ17zYD2b+db4YCuA0LFA2yYuslz/xXUv9KmMBY1kht/43LuPiXBJf+FssisXVG8rFxLNqcHQodroYfevSAHU56r1FEFo/xs9RMVGHcto+qLlZTLMqDJbahmuTLR58xtWAxyxCkn+0lK87tPbBWVkSky0+u1SJD6VuGObCZsBJ6fCZh2irEueVXCVy6PcpRyaQ/fVS4d/Q==.DXb7SF0uh23sbZwbZtkIyw==

Proxy Environment Key

yaml
proxy: host: 192.0.2.1 port: 4444 auth: method: ASSETS_KEY username: api_tests_user_proxy password: secure!BodarDz0YQsb6OLwDXl8pA==.2CoOf7LKRBfq5JhF1rc2OQ== asset: WorkshopDevsSSH passphrase: secure!BodarDz0YQsb6OLwDXl8pA==.2CoOf7LKRBfq5JhF1rc2OQ==

Last modified on May 8, 2025