CodeDeploy

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

application_namerequired string

The name of the application.

integrationrequired Integration

The integration.

regionrequired string

The name of the Amazon S3 region. The full list of regions is available here.

group_namestring

The Amazon S3 group name.

config_namestring

The name of the CodeDeploy configuration.

descriptionstring

The comment about the deployment.

ignore_application_stop_failuresboolean

See here.

update_outdated_instances_onlyboolean

See here.

wait_for_finish_deploymentboolean

Defines whether to wait for the finish of the deployment in Amazon Code Deploy.

file_exist_behaviorstring

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment. Can be one of DISALLOW, OVERWRITE, RETAIN. See here.

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.

local_pathstring

The path in the repository.

Last modified on Apr 8, 2025

Previous pageCode sign and export an iOS app Next pageCompress images

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": "Upload files to Code Deploy",
 "type": "CODE_DEPLOY",
 "trigger_time": "ON_EVERY_EXECUTION",
 "integration": {
 "hash_id": "5ddb7c180fb38be67bd78a88a"
 },
 "local_path": "/",
 "application_name": "tests",
 "region": "us-east-1",
 "group_name": "DemoFleet",
 "config_name": "CodeDeployDefault.OneAtATime",
 "description": "Deploy comment.",
 "ignore_application_stop_failures": false,
 "update_outdated_instances_only": false,
 "wait_for_finish_deployment": true,
 "file_exist_behavior": "OVERWRITE",
 "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/845",
 "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/845/edit",
 "id": 845,
 "name": "Upload files to Code Deploy",
 "type": "CODE_DEPLOY",
 "local_path": "/",
 "trigger_time": "ON_EVERY_EXECUTION",
 "last_execution_status": "INITIAL",
 "application_name": "tests",
 "group_name": "DemoFleet",
 "config_name": "CodeDeployDefault.OneAtATime",
 "description": "Deploy comment.",
 "ignore_application_stop_failures": false,
 "update_outdated_instances_only": false,
 "wait_for_finish_deployment": true,
 "file_exist_behavior": "OVERWRITE",
 "region": "us-east-1",
 "deployment_excludes": [
 "/tmp/",
 "*.log"
 ],
 "deployment_includes": [
 "/assets/style",
 "/tmp/file.txt"
 ],
 "integration": {
 "url": "https://api.buddy.works/workspaces/buddy/user/integrations/33",
 "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": "Live mirror",
 "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