Amazon S3

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

Hint

List with common parameters for all Buddy 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 AMAZON_S3.

bucket_namerequired string

The name of the Amazon S3 Bucket.

integrationrequired Integration

The integration.

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.

local_pathstring

The path in the repository.

aclstring

Access 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_pathstring

The absolute or relative path on the remote server.

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 date

Specifies the expiration period for the objects (how long they stay in the cache).

cache_controlstring

Specifies how long objects stay in the cache.

skip_content_type_settingboolean

When set to true all files will have their mime-types set to application/octet-stream.

reduced_redundancyboolean

Set to true if you want to use Reduced Redundancy Storage.

deploy_tagsTag[]

Defines tags for files categorization as a key value pairs list.

deletion_disabledboolean

If set to true, files are not deleted if changeset indcates that.

content_encodingstring

ContentEncoding that will be set for the deployed files e.g. "gzip".

Last modified on Oct 29, 2024

Add action AWS App Runner Deploy

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": "Upload files to Amazon S3",
  "type": "AMAZON_S3",
  "input_type": "SCM_REPOSITORY",
  "trigger_time": "ON_EVERY_EXECUTION",
  "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",
  "deploy_tags": [
    {
      "key": "revision",
      "value": "$BUDDY_RUN_COMMIT"
    },
    {
      "key": "buddy_last_modification_type",
      "value": "$BUDDY_EXECUTION_FILE_MODIFICATION_TYPE"
    }
  ],
  "deletion_disabled": true,
  "deployment_excludes": [
    "/tmp/",
    "*.log"
  ],
  "deployment_includes": [
    "/assets/style",
    "/tmp/file.txt"
  ],
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}'

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": "Upload files to Amazon S3",
  "type": "AMAZON_S3",
  "trigger_time": "ON_EVERY_EXECUTION",
  "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",
  "deploy_tags": [
    {
      "key": "revision",
      "value": "$BUDDY_RUN_COMMIT"
    },
    {
      "key": "buddy_last_modification_type",
      "value": "$BUDDY_EXECUTION_FILE_MODIFICATION_TYPE"
    }
  ],
  "deletion_disabled": true,
  "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",
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "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