Download S3

POST Parameters

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

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to AMAZON_S3.
bucket_name
Required
StringThe name of the Amazon S3 Bucket.
source_path
Required
StringThe path from which the file will be downloaded.
destination_path
Required
StringThe path in which the file will be saved.
integration
Required
IntegrationThe ID of the integration.
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.

Example

Request

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

JSON

{
"name":"Download files from AWS S3/",
"type":"DOWNLOAD_S3",
"trigger_time":"ON_EVERY_EXECUTION",
"bucket_name":"bucketname",
"source_path":"source",
"destination_path":"destination",
"integration":{
"hash_id":"5ddb7c180fb38be67bd78a88a"
},
"overwrite":true,
"recursive":true
}

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 AWS S3/",
"type":"DOWNLOAD_S3",
"trigger_time":"ON_EVERY_EXECUTION",
"last_execution_status":"INITIAL",
"source_path":"source",
"bucket_name":"bucketname",
"integration":{
"url":"https://api.buddy.works/workspaces/buddy/user/integrations/5dcd43cee36b2f53f1555978",
"html_url":"https://buddy.works/my-id",
"hash_id":"5ddb7c180fb38be67bd78a88a",
"type":"AMAZON"
},
"recursive":true,
"overwrite":true,
"destination_path":"destination",
"trigger_condition":"ALWAYS",
  "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",
  "trigger_mode":"MANUAL",
  "ref_name":"master",
  "last_execution_status":"SUCCESSFUL",
  "last_execution_revision":"506a3963507943d6908154f4bc9646e829128a08"
}
}