SFTP with YAML
Tip
Learn more about:
SFTP [Password]
YAML parameters for SFTP
| Name | Type | Description |
|---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to SFTP. |
authentication_mode Required | String | The authentication mode for SSH. Should be set to PASS. |
host Required | String | The host for the connection. |
login Required | String | The username required to connect to the server. |
port Required | String | The port for the connection. |
| 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. |
| password | String | The password required to connect to the server. |
| 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. |
YAML example for SFTP
yamlactions: - action: "Upload files to localhost" type: "SFTP" input_type: "SCM_REPOSITORY" local_path: "/src" use_temporary_files: true remote_path: "/www" login: "api_tests_user" password: "$api_tests_password" host: "localhost" port: "22" authentication_mode: "PASS" deployment_excludes: - "/tmp" - "*.log" deployment_includes: - "/tmp/assets" - "/tmp/styles"
SFTP [Private key]
YAML parameters for SFTP
| Name | Type | Description |
|---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to SFTP. |
authentication_mode Required | String | The authentication mode for SSH. Should be set to PRIVATE_KEY or ENV_KEY. |
host Required | String | The host for the connection. |
login Required | String | The username required to connect to the server. |
port Required | String | The port for the connection. |
server_key Required | String | The private SSH key. Required if authentication_mode is set to PRIVATE_KEY. |
env_key Required | String | The private SSH key name defined in environment variables. Required if authentication_mode is set to ENV_KEY. |
| 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. |
| passphrase | String | The passphrase for the private SSH key. |
| 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. |
YAML example for SFTP
yamlactions: - action: "Upload files to localhost" type: "SFTP" input_type: "SCM_REPOSITORY" local_path: "/src" remote_path: "/www" use_temporary_files: true login: "api_tests_user" host: "localhost" port: "22" server_key: "-----BEGIN RSA PRIVATE KEY-----\r\nProc-Type: 4,ENCRYPTED\r\nDEK-Info: DES-EDE3-CBC,688DBB59CFC83D58\r\n\r\n1m3qZGEqXEfLPIm9KZacr17/iMVOIJcvSLoMJueM8+QbcK4JStzbre2AN99TkCN/\r\nr1V12deiq/lJUPX07K30tnsTS+7z4Pq/D2WhirD+WQcREgdQU1A8dlx2NMRDi7d0\r\n32w8ZPlciz3bc5rpF0vy5Ll2q9TWye4fpgQwPUnEkam0SaRRwAMpnT/46/AeWgmn\r\n9nu8CNZp7QcOIR2WH6RNRhQTOD/hC+kVCxbEQUL5MOHV7iZX6BeUwd8bBNmci+o0\r\nz/I7ZLQo596Ih+0KPgA+vwS9c4c1TrUYhupU7tyIL6PwpAzhlq/UwxeE032AypiI\r\nkpm7z8I7MBYZs0bsS5UOa3FdHF8p38KrxozwQfsOmBxEHpAWM3slvqJpauuJLlyx\r\ncFfzgOTFSsLJ5J59ZdVRpeFr/W5+/9wpc+AJUP80i4pMEWsnamwdK9rU6QwpFiPf\r\nARzk6VdIiDlZRWeyoYcEfOGEJt+J0aSlXkt6BHgvkmDGq0YA9CNqb6GdB9t073yX\r\nCAqsQ/XEvDuZw14KHxErr5aL6uuZiioDhUmoGz9S3HstFR4T0nRmfCSrLyxTFQf1\r\nF0Sn9Dv4LrSGrzM/0svdlqUc5TDxPBVoW2Q56dNkAQwJg0k25x5YLdTUcd4GjbJW\r\n0qLJaO+bxfTDk5rCMHflYNCW18fEdeEvpBwL0ey93+Qya4xqjTOy2fgoz9U0QLUD\r\nfbgWSiFWnurC8I/SYcQUAEOKiYCDRzud92WzyjwRr2yPlcqf/Qi8+VNDyvoGYZgi\r\nD3vgqA9KPKnYkODYKIFTMW0bbRkgnLOsc1v5mkPTerUpeOGWPysOu3WV9if9e2lG\r\npG1gVfRJQei0k5Mex6CCV0gSQbf2MjswiyDvrPQ1yhpCsFeDAGKcLx+GU1/AhLRP\r\np32mqF5XJrMSTvifCGNOHkBMVUXmTjF7KCYZvcsERi1i2xNcwtcsLRm+QJKQsYQf\r\nhJ17/lOOcC8cqVLGmik3adOcOMCWq2b+NjgoJT55Hc0N07ikuQqazhFpZKkMFZEr\r\nFqbDZ2zGMwODjcDancXaghSS7ciIEdoAPGor1rftJ+l2oQVzBPk4pNfBKHJC7UmS\r\nUOGW3rGLSlRQcVEBFHbrsGP/JKXd06Cbrc3kDrdXbO430qRZh9LQQKbjvxHonU8Z\r\nXFeRpwG32YLSCSQunJtoEWQRJpVefc7rEmBAdLfNyA7xyqH2JLtlflaH9QApl7vE\r\nGNJJ5iuHCHPJwfhlaSMBF/Cb9Ofp4BM5fnNKrwaI9twv//U6XhVfYRcaKhCFEoMb\r\nYo4k7cKTQzL95xT1aYnwqSqtaDfoXASoA9j/mD0aMU+9zQEa0tVbJ/6Zjn3vMSTx\r\npvCYkXy9kZzEJZ2r7BiaQX0HX5Ki/Opt4eTWL5NbokDsE1bQu+D2BskJz30pRRRK\r\nvRargCRNl26158HNRLPkbo/gkwfJbfIBFgJ8YEQkcNap110oEaW6l3lnktZ0Ct3P\r\nEjkrppoV6UU1HCVmcoljOldTXQZuKmpz7aIuSwmUqoU4vWNvYteIZ3BhaVwCu/p8\r\nVaFL8Sapda0WYXPWXHuV+Dj295bedJxeqraWrQB87vKP4NVyzWv1WA==\r\n-----END RSA PRIVATE KEY-----\r\n" passphrase: "api_tests_passphrase" authentication_mode: "PRIVATE_KEY" deployment_excludes: - "/tmp" - "*.log" deployment_includes: - "/tmp/assets" - "/tmp/styles"
SFTP [Private Key & Password]
YAML parameters for SFTP
| Name | Type | Description |
|---|---|---|
action Required | String | The ID of the action. |
type Required | String | The type of the action. Should be set to SFTP. |
authentication_mode Required | String | The authentication mode for SSH. Should be set to PRIVATE_KEY_AND_PASS. |
host Required | String | The host for the connection. |
login Required | String | The username required to connect to the server. |
password Required | String | The password required to connect to the server. |
port Required | String | The port for the connection. |
server_key Required | String | The private SSH key. |
| 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. |
| passphrase | String | The passphrase for the private SSH key. |
| 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. |
YAML example for SFTP
yamlactions: - action: "Upload files to localhost" type: "SFTP" input_type: "SCM_REPOSITORY" local_path: "/src" remote_path: "/www" use_temporary_files: true login: "api_tests_user" host: "localhost" port: "22" server_key: "-----BEGIN RSA PRIVATE KEY-----\r\nProc-Type: 4,ENCRYPTED\r\nDEK-Info: DES-EDE3-CBC,688DBB59CFC83D58\r\n\r\n1m3qZGEqXEfLPIm9KZacr17/iMVOIJcvSLoMJueM8+QbcK4JStzbre2AN99TkCN/\r\nr1V12deiq/lJUPX07K30tnsTS+7z4Pq/D2WhirD+WQcREgdQU1A8dlx2NMRDi7d0\r\n32w8ZPlciz3bc5rpF0vy5Ll2q9TWye4fpgQwPUnEkam0SaRRwAMpnT/46/AeWgmn\r\n9nu8CNZp7QcOIR2WH6RNRhQTOD/hC+kVCxbEQUL5MOHV7iZX6BeUwd8bBNmci+o0\r\nz/I7ZLQo596Ih+0KPgA+vwS9c4c1TrUYhupU7tyIL6PwpAzhlq/UwxeE032AypiI\r\nkpm7z8I7MBYZs0bsS5UOa3FdHF8p38KrxozwQfsOmBxEHpAWM3slvqJpauuJLlyx\r\ncFfzgOTFSsLJ5J59ZdVRpeFr/W5+/9wpc+AJUP80i4pMEWsnamwdK9rU6QwpFiPf\r\nARzk6VdIiDlZRWeyoYcEfOGEJt+J0aSlXkt6BHgvkmDGq0YA9CNqb6GdB9t073yX\r\nCAqsQ/XEvDuZw14KHxErr5aL6uuZiioDhUmoGz9S3HstFR4T0nRmfCSrLyxTFQf1\r\nF0Sn9Dv4LrSGrzM/0svdlqUc5TDxPBVoW2Q56dNkAQwJg0k25x5YLdTUcd4GjbJW\r\n0qLJaO+bxfTDk5rCMHflYNCW18fEdeEvpBwL0ey93+Qya4xqjTOy2fgoz9U0QLUD\r\nfbgWSiFWnurC8I/SYcQUAEOKiYCDRzud92WzyjwRr2yPlcqf/Qi8+VNDyvoGYZgi\r\nD3vgqA9KPKnYkODYKIFTMW0bbRkgnLOsc1v5mkPTerUpeOGWPysOu3WV9if9e2lG\r\npG1gVfRJQei0k5Mex6CCV0gSQbf2MjswiyDvrPQ1yhpCsFeDAGKcLx+GU1/AhLRP\r\np32mqF5XJrMSTvifCGNOHkBMVUXmTjF7KCYZvcsERi1i2xNcwtcsLRm+QJKQsYQf\r\nhJ17/lOOcC8cqVLGmik3adOcOMCWq2b+NjgoJT55Hc0N07ikuQqazhFpZKkMFZEr\r\nFqbDZ2zGMwODjcDancXaghSS7ciIEdoAPGor1rftJ+l2oQVzBPk4pNfBKHJC7UmS\r\nUOGW3rGLSlRQcVEBFHbrsGP/JKXd06Cbrc3kDrdXbO430qRZh9LQQKbjvxHonU8Z\r\nXFeRpwG32YLSCSQunJtoEWQRJpVefc7rEmBAdLfNyA7xyqH2JLtlflaH9QApl7vE\r\nGNJJ5iuHCHPJwfhlaSMBF/Cb9Ofp4BM5fnNKrwaI9twv//U6XhVfYRcaKhCFEoMb\r\nYo4k7cKTQzL95xT1aYnwqSqtaDfoXASoA9j/mD0aMU+9zQEa0tVbJ/6Zjn3vMSTx\r\npvCYkXy9kZzEJZ2r7BiaQX0HX5Ki/Opt4eTWL5NbokDsE1bQu+D2BskJz30pRRRK\r\nvRargCRNl26158HNRLPkbo/gkwfJbfIBFgJ8YEQkcNap110oEaW6l3lnktZ0Ct3P\r\nEjkrppoV6UU1HCVmcoljOldTXQZuKmpz7aIuSwmUqoU4vWNvYteIZ3BhaVwCu/p8\r\nVaFL8Sapda0WYXPWXHuV+Dj295bedJxeqraWrQB87vKP4NVyzWv1WA==\r\n-----END RSA PRIVATE KEY-----\r\n" passphrase: "api_tests_passphrase" password: "api_tests_password" authentication_mode: "PRIVATE_KEY_AND_PASS" deployment_excludes: - "/tmp" - "*.log" deployment_includes: - "/tmp/assets" - "/tmp/styles"
Proxy
To define a proxy server, use the following parameters:
| Name | Type | Description |
|---|---|---|
| proxy_login | String | The username required to connect to the proxy server. |
| proxy_host | String | The host for the proxy connection. |
| proxy_port | String | The port for the proxy connection. |
| proxy_authentication_mode | String | The authentication mode for SSH proxy connection. Can be set to PASS, PRIVATE_KEY, PRIVATE_KEY_AND_PASS or ENV_KEY. |
| proxy_password | String | The password required to connect to the proxy server. |
| proxy_passphrase | String | The passphrase for the private SSH key. |
| proxy_env_key | String | The private SSH key name defined in environment variables. |
| proxy_server_key | String | The private SSH key. |
Example for Proxy Password
yamlproxy_authentication_mode: "PASS" proxy_login: "proxyUser" proxy_host: "proxyHost" proxy_port: "proxyPort" proxy_password: "secure!k/jFegNf7aQx45852g39dg==.N3PyCtKkDwTnpVvXp5RHbw=="
Example for Proxy Private Key
yamlproxy_authentication_mode: "PRIVATE_KEY" proxy_login: "proxyUser" proxy_host: "proxyHost" proxy_port: "proxyPort" proxy_passphrase: "secure!k/jFegNf7aQx45852g39dg==.N3PyCtKkDwTnpVvXp5RHbw==" proxy_server_key: "secure!k/jFegNf7aQx45852g39dg==.N3PyCtKkDwTnpVvXp5RHbw=="
Example for Proxy Private Key and Password
yamlproxy_authentication_mode: "PRIVATE_KEY_AND_PASS" proxy_login: "proxyUser" proxy_host: "proxyHost" proxy_port: "proxyPort" proxy_password: "secure!k/jFegNf7aQx45852g39dg==.N3PyCtKkDwTnpVvXp5RHbw==" proxy_passphrase: "secure!k/jFegNf7aQx45852g39dg==.N3PyCtKkDwTnpVvXp5RHbw==" proxy_server_key: "secure!k/jFegNf7aQx45852g39dg==.N3PyCtKkDwTnpVvXp5RHbw=="
Example for Proxy Env Key
yamlproxy_authentication_mode: "ENV_KEY" proxy_login: "proxyUser" proxy_host: "proxyHost" proxy_port: "proxyPort" proxy_env_key: "secure!ioUb9m6kYw1HgYw9Bg5Yqw==.lstPCaFyljrGmSbpb6M6VQ=="
Last modified on Sep 23, 2024