Download FTP

Learn more about:

POST Parameters

List with common parameters for all Buddy actions

NameTypeDescription
name
Required		StringThe name of the action.
type
Required		StringThe type of the action. Should be set to DOWNLOAD_FTP.
source_path
Required		StringThe path from which the file will be downloaded.
destination_path
Required		StringThe path in which the file will be saved.
host
Required		StringThe host for the connection.
login
Required		StringThe username required to connect to the server.
password
Required		StringThe password required to connect to the server.
portStringThe 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.
download_excludesString[]The paths and/or files that will be left out during the download.
download_includesString[]The exceptions from the ignore patterns set in download_excludes.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
  "name":"Download files from $host by FTP",
  "login":"pass",
  "password":"testtest",
  "host":"$host",
  "port":"21",
  "type":"DOWNLOAD_FTP",
  "trigger_time":"ON_EVERY_EXECUTION",
  "source_path":"source",
  "destination_path":"destination",
  "recursive":false,
  "overwrite":false,
  "download_excludes": [
    "/tmp",
    "*.log"
  ],
  "download_includes": [
    "/tmp/assets",
    "/tmp/styles"
  ]
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "url":"https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url":"https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
  "id":2,
  "name":"Download files from $host by FTP",
  "type":"DOWNLOAD_FTP",
  "trigger_time":"ON_EVERY_EXECUTION",
  "last_execution_status":"INITIAL",
  "source_path":"source",
  "login":"pass",
  "password":"secure!3izthXeryQmj1cDUwH5zaQ==",
  "host":"$host",
  "port":"21",
  "recursive":false,
  "overwrite":false,
  "destination_path":"destination",
  "download_excludes": [
    "/tmp",
    "*.log"
  ],
  "download_includes": [
    "/tmp/assets",
    "/tmp/styles"
  ],
  "pipeline":{
    "url":"https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url":"https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id":2,
    "name":"test server",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status":"SUCCESSFUL",
    "last_execution_revision":"506a3963507943d6908154f4bc9646e829128a08"
  }
}
Questions?

Not sure how to configure a pipeline for your process? Reach out on the live-chat, contact support, or ask our community on our forum.

Sign up for Buddy Digest

Best practices on CI/CD and fresh changelogs delivered weekly to your inbox.