CloudFront

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

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

workspacerequired string

The workspace name.

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 CLOUD_FRONT.

distribution_idrequired string

The ID of the Cloudfront web distribution.

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.

base_urlstring

The absolute or relative path on the remote server.

purge_allboolean

Specifies whether or not the whole cache should be removed.

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.

Last modified on Apr 8, 2025

Previous pageCloudflare Next pageCode sign and export an iOS app

Example:

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
 -H "Authorization: Bearer <YOUR-TOKEN>" \
 -H "Content-Type: application/json" \
 -d '{
 "name": "Cloudfront action",
 "type": "CLOUD_FRONT",
 "trigger_time": "ON_EVERY_EXECUTION",
 "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"
 ]
}'

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": "Cloudfront action",
 "type": "CLOUD_FRONT",
 "trigger_time": "ON_EVERY_EXECUTION",
 "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",
 "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