Download SFTP (Private key from environment variables)

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to DOWNLOAD_SSH.
source_pathrequired string
The path from which the file will be downloaded.
destination_pathrequired string
The path in which the file will be saved.
authentication_moderequired string
The authentication mode for SSH. Should be set to ENV_KEY.
hostrequired string
The host for the connection.
loginrequired string
The username required to connect to the server.
env_keyrequired string
The private SSH key name defined in environment variables.
portrequired string
The port for the connection.
overwriteoptional boolean
Replace files if they already exist.
recursiveoptional boolean
If set to true, the whole directory tree is downloaded, otherwise only the files from the path are downloaded.
download_excludesoptional string[]
The paths and/or files that will be left out during the download.
download_includesoptional string[]
The exceptions from the ignore patterns set in download_excludes.

Last modified on Oct 7, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Download files from $host",
  "type": "DOWNLOAD_SSH",
  "source_path": "source",
  "destination_path": "destination",
  "login": "username",
  "host": "$host",
  "port": "22",
  "env_key": "envkey",
  "authentication_mode": "ENV_KEY",
  "recursive": true,
  "overwrite": true,
  "trigger_time": "ON_EVERY_EXECUTION",
  "download_excludes": [
    "/tmp",
    "*.log"
  ],
  "download_includes": [
    "/tmp/assets",
    "/tmp/styles"
  ]
}'
EXAMPLE RESPONSE
{ "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", "type": "DOWNLOAD_SSH", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "source_path": "source", "login": "username", "host": "$host", "env_key": "secure!PuYmIP3yRej9rErRBfp2eg==", "authentication_mode": "ENV_KEY", "recursive": true, "overwrite": true, "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" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999