Download SFTP with YAML

Download SFTP [Password]

YAML parameters for Download SFTP

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to DOWNLOAD_SSH.
source_path
Required
StringThe path from which the file will be downloaded.
destination_path
Required
StringThe path in which the file will be saved.
authentication_mode
Required
StringThe authentication mode for SSH. Should be set to PASS.
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.

YAML example for Download SFTP

actions:
- action: "Download files from $host"
type: "DOWNLOAD_SSH"
source_path: "source"
destination_path: "destination"
login: "username"
password: "secure!5UXoMgihE1fTjZLTupXKQw=="
host: "$host"
port: "22"
authentication_mode: "PASS"
recursive: true
overwrite: true

Download SFTP [Private key]

YAML parameters for Download SFTP

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to DOWNLOAD_SSH.
source_path
Required
StringThe path from which the file will be downloaded.
destination_path
Required
StringThe path in which the file will be saved.
authentication_mode
Required
StringThe authentication mode for SSH. Should be set to PRIVATE_KEY.
port
Required
StringThe port for the connection.
host
Required
StringThe host for the connection.
login
Required
StringThe username required to connect to the server.
server_key
Required
StringThe private SSH key. Required if authentication_mode is set to PRIVATE_KEY.
passphraseStringThe passphrase for the private SSH key.
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.

YAML example for Download SFTP

actions:
- action: "Download files from $host"
type: "DOWNLOAD_SSH"
source_path: "source"
destination_path: "destination"
login: "username"
host: "$host"
port: "22"
server_key: "secure!DJmUNkJKHUaijmYZogZ5sFy6BpsP77csTkt0iRQqtv36jKbwZJvUISWWauhGUfpS/kENJ3X2QjY2zTebgvlzEfOKB+KmbiWoCYyeGTuLRC22gsuIG2h66lbRQXOLbIQWyXTrZ/9LRWtytKep3u/5gHHPsCG6kShvMcBZM6iJBc72mgLwLzixyHG1BFxBmXr+hF9yS/sue2h8NnOhY+kQvxLFsWP0Eq6i+PuOAO29ujnr+FXKGKmeT5qDkB+/EfG4vbfLFr2j05J9+risGBafdfWFuSRzeNQlsg8HzJYtO13n5G9hTebRgmKlee/MDX4Gdo8i6pWyddWpwgNbaGNf/afV27ZOMFGfvTy0IS3Hf/Nc9uEn5K+Ej69h9oc7dQskz0lVWewEBa9w5sGTFcZftG0/E5rzxLF90cWcdJiTtCMhsShlXqJDdgzpCjg3Fk+2DniXYM8tJCGBhgFgU0gqHz8x/A/wjWMmU7LuvfLeVGJe/KxQ551QqDytZpyH36PAsN/0VAC8sfskELuZukKMQRU82xqDTJCMlSu8ezyLLb9utakm7sGHBw3HWJe/ayABUN7g1bYYGYx9cTMf7eaRm78ZH5bA7SyXPfMOPhiGteQ2stSu5d9QisaUVaFNJRpv9aRN/7uNm7jfg8n4JRrvscsSqgx4m2hcsIyWQ0vGv4O4mRWANhpZskix6QgfUNoW6iOEKhEQB+NCAewMQi4WLuFylstJU3L1mAxhPA6PFQetJb2L9eUD8oibTfDUSKDwdBhdLZ8P2POPo5b0Ls92f0ktAK0eOHSr8i0LrW0JWziX6rxz2Eg8td4rjSswgcyLS9aRtHeINKPVYg5l3sODAfu3CzqAnCjMBg/FzxtaffZ1RZUyRzyw+g1XcE8lFfR6W+SVgtNQJaCfSoQRLTOJuEH6K88ha8DkJm95dQ9NBS66r2Aws7TINiZKr3SE1P8srtrNGymfAYoZgz6C3cu9uPTJrORTAoabMvcJIIpIkTpm5sA6Hj19YrmwU4iE7uvIFrlk5+zqq1fq+Gq1J7yJcD6qGgPPZQT6FPooqedSiOIzc+8/BvUwbAyb4qws5nRnaQeSNv4Bl4wpzCu/vgSgTRNGls6zxiNcphO1O5BRwTdpB3rKp910Y+BNhiTXf7n+spswyAGGHPIz/59rqpMTfNnvUF0xeMp6skEcFLV/O9A8yMVrGR5482DZE3yOgKpNN21gpaju9u+1S7FW6CS5uv6S8SiJTaCiu4fzE243q7fRYOmScX6dk9aJw12TY+5yjBQCUgBtp4xeD6xznB6TQ6LIb5MTxXoG3xI+MDh9uzkAJ+iTFLKAgeftIths0kvXg2HiKpzuLS0dxWQ5itU/zIBWjICGwOHSJyFDjkjbpruKQOAwpGaQX1iUKwPyjKBwQSVYs9pdfC9frP046k++vM+ycNUqGnT8JYncyKVt/ORlSFkzp5SH0ZYz5Chxm5oJky/6fsVSdMcJtmeBWdyXl5Lk0JrKb1xpHoChxuMqfJBvOjRRs6KaTGNAzaHxV1Ft5MRmYOIB+v3sm4NixqRKv1wK9hPthVYXCkByeSzhh8wJywsFjFmh+iNVtnAG+K0JjsClvLADIS/YlFW/K5+NAr3qJOc4VlJeasytExZi+0lFAnl0xVBznQsJeNBPfJWUXsUB+sYjCkcWc9VjK1Fsjbt05xjBOFN8wjjAixiADqS8aKa2bL5qDT6P+ta92LS3F31+3byrSs90Qc/S5BUcmoMikTJdiLM9AMbhVz1P2vPnMkKseA/zd2aQiEAkW/flVOvNLmy7p4tw4mHcFPrhSHYa0gUBR0NpoOwaT9eVY/Eygya0Tc3fCyHrFiMgbsHYdB08f1cUzgVpp09vhCsstn0/6gXKrqPzFYFP/RAfluEnHDtkN2eBF0Vx8jYrLHsQMXm/Rj7mbBlS8+rKQ9Popz4Xv/ISw1okIHTGkoBRlAbhFNGqoes8vhRBnSyuLliGxLSFgFMhUzu5zAq3a9c/JKPSB5jKIX+TUrLQsTCFF6xLTqGnnGR6r227YA9FOLg+D+KDjfRe7LR8tkyfMe8QCPqgC/Mr47jOn5Na27SxYy83JclRAXbCkztTsUSO9OKkCvU0OPO457ADd93f30QQCZQBnBOiqbzo7/bJILGfiRVRLWw+tC+FBkmd6755IOed2u2GmxS8RkeluSM1UNDqzYyMJNIwUumd+7nlmXvKEHQRyl0u8UNf/m9xcw11OLkjJ0YrIfXZ536+J0ijaLmv+l3VrgSblHKjQi1AOOFXRyUIFli/NW8tBdhr8+06sUKrqiELSHXWOL1qmMGH5LwzgAa4OsFQy22P/tGPebmfH2eCxmjdo5caybfdpFbguGA1WVDrKfN79o50lHH+EYbBMf1VAH52cx+MG7zjv9kRRggGLjwQT/c8DvtJfOb/2xNp8id+TIg9N/QRj1hDAqCoJjgHcrMAuGl97GtD0Br4HYA="
passphrase: "secure!nfCk+GRjNmO5MDDWo0YhaQ=="
authentication_mode: "PRIVATE_KEY"
recursive: true
overwrite: true

Download SFTP [Private Key & Password]

YAML parameters for Download SFTP

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to DOWNLOAD_SSH.
source_path
Required
StringThe path from which the file will be downloaded.
destination_path
Required
StringThe path in which the file will be saved.
authentication_mode
Required
StringThe authentication mode for SSH. Should be set to PRIVATE_KEY_AND_PASS.
host
Required
StringThe host for the connection.
port
Required
StringThe port for the connection.
login
Required
StringThe username required to connect to the server.
server_key
Required
StringThe private SSH key. Required if authentication_mode is set to PRIVATE_KEY_AND_PASS.
password
Required
StringThe password required to connect to the server.
passphraseStringThe passphrase for the private SSH key.
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.

YAML example for Download SFTP

actions:
- action: "Download files from $host"
type: "DOWNLOAD_SSH"
source_path: "source"
destination_path: "destination"
login: "username"
password: "secure!eFZnNKPlAOcrTFuuUMwUZA=="
host: "$host"
port: "22"
server_key: "secure!YV0UUNgHJDor+j/91kVLhmXuVQ8Y49wGW72la6oKu7vk8+ELndX2FIQsvFv2w8adJIO2CQpFO3PQ6hFqhhuove6bztwl0gk4zOxqk+XUk5Sii9TQyRbdwtDf1t/lmxcUw0PnU0ZBgEDly8Yaua9w/oLrAn7diQhL7+1aTtt8i+NBmCq2o/hKCnnRUvpCwrgQN+cHOFI+p8RTgTGQ6+8fAqdY2mE1eT2cMv5oMrMzm7SflGTddnGh4RX9cng8Rkl60NHzMX0pOkLCYzsGrP5+QoLiyd49dggaH8kdhNbjXWVDXKeXTIwOiuA5j74SHJlLDXL54c2VJhCjFncS7l3giXrx5ilzbYBggxk30HphNaIGDKLKhvcpS1j5MT0gPmJk/1PMVMloj8dr10Sc84GErkdqv2j2+DLOxsvaU+ciLB+zO3Unul+/C+JXLwpmkyphUO444sXhxpIvSK23nxBFdAgcImF+45F/TaC9iHsmIlLjoeUv7BJeNnXbTRXzjVwnM10qQp5DorN0Wk4HXC+TXvL1hBwn+3iVP2GuL9NJqyuZ+3dEqSYmqGBhahNPFMR65kDHLfdBaRWA0fwqWBwViDNrqDjqyG6pKkBekQrpIHv+ksMDXZti/2O7GhYumUH50dhIvHm3fe//uZuR6LBCj+ssQrbMoaD+1KOK4am7/IdgdhwlUY2XWRLfoCAJ5c3lwElYb/qyEfpyGBKhwpsNjQvDNLJrSqVHJiThUIO7QtjZX2rViD7JKGgXriEEbuOYoFS9bbmUEbYtgN+6+t7zgRlep8RqV0x9hpjxRA+1Hhegol6oWp+uSe/GVpZm7KLkIjnHGVfGjGEqOQgjnIzRoXwnoL0K3eljoQSQxWIyxdfCloqcBwX5m42K4Q5y+6oop3PK/50NddYHuq7qVptaCvkukbguAPALkvfFx5C1hlA6DcfRbNzoap6+dQue/29+NwTwbYs39y9I3meCNjnBVy0CkMfhbvwfo9zEJ5AxyWbIS5skSt7mWzvFPmfGzEUtIPLwd7j3VO8T0VPCkaLZUQtSJ148dQrHS5/ACEUDjHyX+xtXdd8ASKWDDI1SymwKI0N9EoIBBG7WidgDqj+vRwY5ihM/lOeQRCM/amByAmjN1Xl/awr6Sx+3yYVNwyeimlD3Is0MLF05iO7BODLdrnYDEgevyqjFMUnfLM1dQS+w+5E8JabmzQ3gm6eeTNypzXg6+D5rhCxOFaIy0w9QAiHqrkA1ZcLRzjs7QSlbSF/bQGxLuE6p6rZ43Z1+oeCTWHVNo83kNKUZ7F4Qi5Ul7Nl89mH4tY8aZOI1KbYSVk1zMxhft7NT/EqX2TVeCpNvq6b1s7Wal3pcoui/vMB4tHN4XcCUGo0BvdJNxr2+zSC3i75mCFweldT8LU2nzIHIVWMyPA030YQDHo5+1d+Dy/uZNt7sC6l9ffLH9pcvio6INrHIGf6tsU0lRtkSSj5rSEtYP4BIl8UbMoKLzh5muZQOCUEv0Pa8e2R0tYnajkkYuxIWgkex9OOjfRtMBa4SuT908uBDPtUIQenPJHNQ7FhCYfQZqmsFS4YL06iMdmHPccEDB2+LM8VMrDzMrqq4HfkOZql+kL8nQtFZ1sMwwzdSkn1CBuW+tfLjP02EeO/BZisTL2Tg4rSmP3vAHPlBqHw/THgh1X3MunC7ZNzJj0LmYgSxaGCncwtLNhWfbi+/qTKYRwq5ATGNN3je5YUj/Y0uyRlnLuKgHCvIOQCRpJXQGdQbfHCLK8pQLXdGTplNi1YSvp/yqRId6Wg8Ij1mHGn06mjjEOkxmCjPM1la0kuye0ttHhM1KVYYGABcvJADTzYOizz7zfdtDGhgXtgXdOlGFwsjUbhyNqKnRIdwbKskNFxQdVWquJff5XxU8yuSuQ14tnnd0DvFFgYg+0rhKdVUJYatlFOSGyMWW5DGbClxObvqhUwt2CCjBjZu/cojGe86HBGUGmkLNBRdxBlUvUaCZXV7V8g1BGbkuJU13e9CvqVkQ+3SRLZHuXku9UyQ87CpJQ9D5qoZIDCH+Vpj7zFYgAz5yiXG+qG4l4bEUWdusMpsUL58LVZgeeJjm+oElo4eKajbUY6Sw9JSbuQozcHNW3j5KJF5WwUs9yjM27LtN9bIQWp9l9khHb5H7ZibrO2ZIEYfDhDqFjmob7pPQecoW6pNRkB1yzTvVYXL3yjucCBRm1dI6XkYVNTeW/y8SyR83cqHVCP2ZRo77aXAkOutIfKZrB35GmIElAQCmwGnYEegOgAhSZsqIFa1LXnYaOWNnk49vySNeCev7XeXGXejtDHqRMUJ63S7UBqzCk0G2bA90dPIsJsRbPJjhB44YiazsuaHYF7zsJJVMimdxngEj+A+c3/WHPZrOdVezBU/fTlwZIj3LiGu/cL972SlSXTvwJ+Zn6M5GYAcS5krvT3oeGuNc/3r5p/Tq6OrWg=="
passphrase: "secure!BYICUSM6rLTnFVoxW9goOQ=="
authentication_mode: "PRIVATE_KEY_AND_PASS"
recursive: true
overwrite: true

Download SFTP [Private key from environment variables]

YAML parameters for Download SFTP

You can find the list with common parameters for all Buddy actions here.

NameTypeDescription
action
Required
StringThe ID of the action.
type
Required
StringThe type of the action. Should be set to DOWNLOAD_SSH.
source_path
Required
StringThe path from which the file will be downloaded.
destination_path
Required
StringThe path in which the file will be saved.
authentication_mode
Required
StringThe authentication mode for SSH. Should be set to ENV_KEY.
host
Required
StringThe host for the connection.
login
Required
StringThe username required to connect to the server.
env_key
Required
StringThe private SSH key name defined in environment variables.
port
Required
StringThe port for the connection.
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.

YAML example for Download SFTP

actions:
- action: "Download files from $host"
type: "DOWNLOAD_SSH"
source_path: "source"
destination_path: "destination"
login: "username"
host: "$host"
port: "22"
env_key: "secure!YvhFlwSQj1iuWIIFnhNjgA=="
authentication_mode: "ENV_KEY"
recursive: true
overwrite: true