CloudFront
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to CLOUD_FRONT . |
distribution_id Required | String | The ID of the Cloudfront web distribution. |
integration Required | Integration | The integration. |
input_type | String | Defines whether the files are deployed from the repository or from the build filesystem. Can be one of SCM_REPOSITORY or BUILD_ARTIFACTS . |
local_path | String | The path in the repository. |
base_url | String | The absolute or relative path on the remote server. |
purge_all | Boolean | Specifies whether or not the whole cache should be removed. |
deployment_excludes | String[] | The paths and/or files that will be left out during the deployment. Available only if purge_all is set to false . |
deployment_includes | String[] | The exceptions from the ignore patterns set in deployment_excludes . |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{"name": "Cloudfront action","type": "CLOUD_FRONT","trigger_time": "ON_EVERY_EXECUTION","trigger_condition": "ALWAYS","input_type": "SCM_REPOSITORY","local_path": "/","base_url": "/merged","distribution_id": "EDFDVBD632BHDS5","purge_all": false,"timeout": 900,"integration": {"hash_id": "5ddb7c180fb38be67bd78a88a"},"deployment_excludes": ["/tmp/","*.log"],"deployment_includes": ["/assets/style","/tmp/file.txt"],}
Sample Response
HTTP
Status: 201 CreatedX-Rate-Limit-Limit: 1X-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": "Cloudfront action","type": "CLOUD_FRONT","trigger_time": "ON_EVERY_EXECUTION","trigger_condition": "ALWAYS","last_execution_status": "INITIAL","input_type": "SCM_REPOSITORY","local_path": "/","base_url": "/merged","distribution_id": "EDFDVBD632BHDS5","purge_all": false,"timeout": 900,"deployment_excludes": ["/tmp/","*.log"],"deployment_includes": ["/assets/style","/tmp/file.txt"],"integration": {"url": "https://api.buddy.works/workspaces/buddy/user/integrations/2","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","trigger_mode": "MANUAL","ref_name": "master","last_execution_status": "SUCCESSFUL","last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"}}