CodeDeploy

POST Parameters

NameTypeDescription
application_name
Required
StringThe name of the application.
region
Required
StringThe Amazon S3 region.
integration
Required
IntegrationThe integration.
name
Required
StringThe name of the action.
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.
trigger_time
Required
StringSpecifies when the action should be executed. Can be one of ON_EVERY_EXECUTION, ON_FAILUREor ON_BACK_TO_SUCCESS.
type
Required
StringThe type of the action. Should be set to CODE_DEPLOY.
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.
after_action_idIntegerThe numerical ID of the action, after which this action should be added.
trigger_conditionStringDefines when the build action should be run. Can be one of ALWAYS, ON_CHANGE, ON_CHANGE_AT_PATH, VAR_IS, VAR_IS_NOT or VAR_CONTAINS or VAR_NOT_CONTAINS.

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": {
"id": 33
},
"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",
"run_only_on_first_failure": false,
"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",
"id": 33
},
"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"
}
}