CodeDeploy

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to CODE_DEPLOY.
application_name
Required
StringThe name of the application.
integration
Required
IntegrationThe integration.
region
Required
StringThe name of the Amazon S3 region. The full list of regions is available here.
group_nameStringThe Amazon S3 group name.
config_nameStringThe name of the CodeDeploy configuration.
descriptionStringThe comment about the deployment.
ignore_application_stop_failuresBooleanSee here.
update_outdated_instances_onlyBooleanSee here.
wait_for_finish_deploymentBooleanDefines whether to wait for the finish of the deployment in Amazon Code Deploy.
file_exist_behaviorStringInformation 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_pathStringThe path in the repository.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions

JSON

{
"name": "Upload files to Code Deploy",
"type": "CODE_DEPLOY",
"trigger_time": "ON_EVERY_EXECUTION",
"trigger_condition": "ALWAYS",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"local_path": "/",
"application_name": "tests",
"region": "us-west-2",
"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"
],
}

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/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",
"trigger_condition": "ALWAYS",
"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",
"trigger_mode": "MANUAL",
"ref_name": "master",
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}