Amazon S3

POST Parameters

NameTypeDescription
bucket_name
Required
StringThe name of the Amazon S3 Bucket.
integration
Required
IntegrationThe integration.
name
Required
StringThe name of the action.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILURE or ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to AMAZON_S3.
input_typeStringDefines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS.
local_pathStringThe path in the repository.
aclStringAccess control lists (ACLs) enable you to manage access to buckets and objects. It defines which AWS accounts or groups are granted access and the type of access. Can be one of PRIVATE , PUBLIC_READ, AWS-EXEC-READ, AUTHENTICATED_READ, BUCKET_ONWER_READ, BUCKET_OWNER_FULL_CONTROL or LOG_DELIVERY_WRITE.
remote_pathStringThe absolute or relative path on the remote server.
run_only_on_first_failureBooleanDefines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
deployment_excludesString[]The paths and/or files that will be left out during the deployment.
deployment_includesString[]The exceptions from the ignore patterns set in deployment_excludes.
expires_dateISO-8601 UTC dateSpecifies the expiration period for the objects (how long they stay in the cache).
cache_controlStringSpecifies how long objects stay in the cache.
skip_content_type_settingBooleanWhen set to true all files will have their mime-types set to application/octet-stream.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
reduced_redundancyBooleanSet to true if you want to use Reduced Redundancy Storage
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS or VAR_NOT_CONTAINS.

Example

Request

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

JSON

{
"name": "Upload files to Amazon S3",
"type": "AMAZON_S3",
"input_type": "SCM_REPOSITORY",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"local_path": "/assets/",
"remote_path": "Home/www/",
"bucket_name": "buddy-tests",
"acl": "PUBLIC_READ_WRITE",
"run_only_on_first_failure": false,
"skip_content_type_setting": false,
"reduced_redundancy": true,
"expires_date":"2017-01-07T00:00:00.000Z",
"cache_control":"max-age=3600",
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
"integration": {
"id": 1
}
}

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": "Upload files to Amazon S3",
"type": "AMAZON_S3",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"run_only_on_first_failure": false,
"last_execution_status": "INITIAL",
"input_type": "SCM_REPOSITORY",
"local_path": "/assets/",
"remote_path": "Home/www/",
"bucket_name": "buddy-tests",
"acl": "PUBLIC_READ_WRITE",
"skip_content_type_setting": false,
"reduced_redundancy": true,
"expires_date":"2017-01-07T00:00:00.000Z",
"cache_control":"max-age=3600",
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
"integration": {
"url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
"html_url": "https://app.buddy.works/my-id",
"id": 1
},
"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"
}
}