Cloudfront

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 CLOUD_FRONT.
distribution_id
Required
StringThe ID of the Cloudfront web distribution.
integration
Required
IntegrationThe integration.
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.
base_urlStringThe absolute or relative path on the remote server.
purge_allBooleanSpecifies whether or not the whole cache should be removed.
wait_for_completedIntegerSpecifies how long (in minutes) the execution should wait for the invalidation COMPLETED status.
deployment_excludesString[]The paths and/or files that will be left out during the deployment. Available only if purge_all is set to false.
deployment_includesString[]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,
"wait_for_completed": 15,
"integration": {
"id": 2
},
"deployment_excludes": [
"/tmp/",
"*.log"
],
"deployment_includes": [
"/assets/style",
"/tmp/file.txt"
],
}

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": "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,
"wait_for_completed": 15,
"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",
"id": 2
},
"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"
}
}