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 TRANSFER. |
targets Required | Target[] | Defines a target (server) for your deployments using the following parameters. |
| input_type | String | Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS. |
| local_path | String | The path in the repository. |
| remote_path | String | The absolute or relative path on the remote server. |
| deployment_excludes | String[] | The paths and/or files that will be left out during the deployment. |
| deployment_includes | String[] | The exceptions from the ignore patterns set in deployment_excludes. |
| use_temporary_files | Boolean | The files will be uploaded with a "tmp" suffix that will be removed once the upload has finished. |
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. |
| port | String | Port for the connection |
| path | String | Path on the server defined in the target. |
| integration | String | Required when type is UPCLOUD, EC2, VULTR or DIGITAL_OCEAN. Identifier of the integration. |
| secure | Boolean | For 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). |
| region | String | Defines the source region of EC2 addresses. Required for EC2 target. |
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 |
|---|
| name | String | Name of the proxy server. |
| 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
Transfer FTP/FTPS
actions:
- action: Upload files to localhost
type: TRANSFER
local_path: /
remote_path: Home/www
deployment_excludes:
- /assets
- file.txt
deployment_includes:
- /assets/assets-new/
- /assets/file.txt
targets:
- target: ftps_target_1
type: FTP
secure: true
host: 192.0.2.1
auth:
username: api_tests_user
password: secure!n4eFpObbQFQAAo1PNLcI7sAuMHU4hONGPOub0NnMIfs=.KHOPp6ezg4uwy8pAmD0VZQ==
Transfer SFTP (Password)
actions:
- action: Upload files to localhost
type: TRANSFER
local_path: /
remote_path: Home/www
deployment_excludes:
- /assets
- file.txt
deployment_includes:
- /assets/assets-new/
- /assets/file.txt
targets:
- target: sftp_target_3
type: SSH
host: 192.0.2.1
auth:
username: api_tests_user
password: secure!n4eFpObbQFQAAo1PNLcI7sAuMHU4hONGPOub0NnMIfs=.KHOPp6ezg4uwy8pAmD0VZQ==
Transfer SFTP (Key & Password)
actions:
- action: Upload files to localhost
type: TRANSFER
local_path: /
remote_path: Home/www
deployment_excludes:
- /assets
- file.txt
deployment_includes:
- /assets/assets-new/
- /assets/file.txt
targets:
- target: sftp_target_4
type: SSH
host: 192.0.2.1
auth:
method: ASSETS_KEY
username: api_tests_user
password: secure!n4eFpObbQFQAAo1PNLcI7sAuMHU4hONGPOub0NnMIfs=.KHOPp6ezg4uwy8pAmD0VZQ==
asset: id_project
Transfer SFTP (Private Key & Password)
actions:
- action: Upload files to localhost
type: TRANSFER
local_path: /
remote_path: Home/www
deployment_excludes:
- /assets
- file.txt
deployment_includes:
- /assets/assets-new/
- /assets/file.txt
targets:
- target: sftp_target_2
type: SSH
host: 192.0.2.1
auth:
method: SSH_KEY
username: api_tests_user
passphrase: secure!AldjvqzEoFp4f6wl0Dqstf9laCj1I63gQHaaxF0At78=.6hGZz/VNSEVh3lY1RgilfQ==
key: secure!AldjvqzEoFp4f6wl0Dqstf9laCj9fg6h03HaaxF0At78=.6hGZz/VNSEVh3lY1RgilfQ==
SSH target with integration
actions:
- action: Transfer files to DigitalOcean
type: TRANSFER
local_path: /
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
Proxy
actions:
- action: Upload files to localhost with proxy
type: TRANSFER
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
proxy:
host: 192.0.2.1
port: 4444
auth:
username: api_tests_user_proxy
password: secure!Dyzh9UQU9RwWbPx3ZWUs5g==.S04TxgmIzIE++wXtjk9bIw==
Proxy Private Key
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
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
proxy:
host: 192.0.2.1
port: 4444
auth:
method: ASSETS_KEY
username: api_tests_user_proxy
password: secure!BodarDz0YQsb6OLwDXl8pA==.2CoOf7LKRBfq5JhF1rc2OQ==
asset: id_project
passphrase: secure!BodarDz0YQsb6OLwDXl8pA==.2CoOf7LKRBfq5JhF1rc2OQ==