Download

View as Markdown

POST
/workspaces
/:workspace
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Download action covers FTP, FTPS and SSH download activities.

Info

List with common parameters for all Buddy actions

Request

URL PARAMETERS

workspacerequiredstring

The workspace name.

pipeline_idrequiredinteger

The numerical ID of the desired pipeline.

project_namerequiredstring

The name ID of the project.

POST PARAMETERS

namerequiredstring

The name of the action

typerequiredstring

Defines the type of the action. Should be set to DOWNLOAD

targetsrequiredstring

Define a target (server) for your deployments using the following paramters

input_typestring

Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.

source_pathrequiredstring

The path from which the file will be downloaded.

destination_pathrequiredstring

The path in which the file will be saved.

download_excludesstring[]

The paths and/or files that will be left out during the deployment for the DOWNLOAD type action.

download_includesstring[]

The exceptions from the ignore patterns set in deployment_excludes. For the DOWNLOAD type action.

overwriteboolean

Replace files if they already exist.

recursiveboolean

If set to true, the whole directory tree is downloaded, otherwise only the files from the path are downloaded.

regionstring

Defines the source region of EC2 addresses. Required for EC2 target. (Avaible only for EC2 target).

Last modified on Jan 19, 2026

Transfer SSH Command

Request examples

Download FTP server


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Download files from FTP server",
  "type": "DOWNLOAD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "source_path": "/source",
  "recursive": false,
  "targets": [
    {
      "type": "FTP",
      "secure": false,
      "identifier": "ftp_target_1",
      "host": "192.0.2.1",
      "port": "21",
      "auth": {
        "username": "user",
        "password": "secure!gYTKjljwPt4nAffHn6mGEQ==.5rkCAHX55eiwOqJ73oGg6g=="
      },
      "path": "/var/www"
    }
  ],
  "destination_path": "/assets",
  "overwrite": false
}'

Download SSH (password)


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Download files from SSH server by pass",
  "type": "DOWNLOAD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "source_path": "/source",
  "recursive": false,
  "targets": [
    {
      "type": "SSH",
      "identifier": "ftjbtgjals",
      "host": "192.0.2.1",
      "port": "22",
      "auth": {
        "method": "PASSWORD",
        "username": "sftp-pass-0",
        "password": "$MyPassword"
      }
    }
  ],
  "destination_path": "/assets",
  "overwrite": false
}'

Download SSH (key)


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Download files from SSH server with asset_key",
  "type": "DOWNLOAD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "source_path": "/source",
  "recursive": false,
  "targets": [
    {
      "type": "SSH",
      "identifier": "bctqrryybe",
      "host": "192.0.2.1",
      "port": "22",
      "auth": {
        "method": "ASSETS_KEY",
        "username": "sftp-key-phrase-0",
        "asset": "id_project"
      }
    }
  ],
  "destination_path": "/assets",
  "overwrite": false
}'

Download SSH (password and key)


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Download files from SSH server by password and key passphrase",
  "type": "DOWNLOAD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "source_path": "/source",
  "recursive": false,
  "targets": [
    {
      "type": "SSH",
      "identifier": "flcroghbuu",
      "host": "192.0.2.1",
      "port": "22",
      "auth": {
        "method": "SSH_KEY",
        "username": "sftp-pass-key-phrase-0",
        "password": "$MyPassword",
        "passphrase": "$MyPassphrase",
        "key": "$MyKey"
      }
    }
  ],
  "destination_path": "/assets",
  "overwrite": false
}'

Download SFTP with Integration


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Download files to 192.0.2.1 by SFTP with Integration",
  "type": "DOWNLOAD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/",
  "remote_path": "",
  "targets": [
    {
      "identifier": "do_server",
      "type": "DIGITAL_OCEAN",
      "host": "buddy-tests",
      "port": "6464",
      "path": "Home/www",
      "auth": {
        "method": "PASSWORD",
        "username": "sftp-pass-key-phrase-0",
        "password": "$MyPassword"
      },
      "integration": "digitalocean"
    }
  ]
}'

Proxy


curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Download files from SSH server by pass with Proxy",
  "type": "DOWNLOAD",
  "trigger_time": "ON_EVERY_EXECUTION",
  "input_type": "SCM_REPOSITORY",
  "local_path": "/",
  "remote_path": "",
  "targets": [
    {
      "identifier": "sftp_target_3",
      "type": "SSH",
      "host": "192.0.2.1",
      "port": "22",
      "auth": {
        "method": "PASSWORD",
        "username": "sftp-pass-0",
        "password": "$MyPassword"
      },
      "proxy": {
        "host": "proxy.myserver.com",
        "port": "80",
        "auth": {
          "method": "PASSWORD",
          "username": "api_tests_user_proxy",
          "password": "$MyPassword"
        }
      }
    }
  ]
}'

Response examples