AWS CDK CLI

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

Request

URL PARAMETERS
workspacerequiredstring
The workspace name.
pipeline_idrequiredinteger
The numerical ID of the desired pipeline.
project_namerequiredstring
The name ID of the project.
POST PARAMETERS
namerequiredstring
The name of the action.
typerequiredstring
The type of the action. Should be set to AWS_CDK_CLI.
execute_commandsrequiredstring
The commands that will be executed.
regionrequiredstring
The name of the Amazon region.
integrationrequiredIntegration
The integration.
shellstring
The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.
setup_commandsstring
The command that will be executed only on the first run.

Last modified on Jan 19, 2026

Request 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": "Run AWS CDK commands", "type": "AWS_CDK_CLI", "trigger_time": "ON_EVERY_EXECUTION", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "cdk --version" ], "shell": "SH", "integration": { "identifier": "5ddb7c180fb38be67bd78a88a" }, "region": "us-west-2" }'

Response

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/action/2/edit", "id": 2, "name": "Run AWS CDK commands", "type": "AWS_CDK_CLI", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "setup_commands": [ "apt-get update && apt-get -y install git" ], "execute_commands": [ "cdk --version" ], "shell": "SH", "integration": { "identifier": "5ddb7c180fb38be67bd78a88a" }, "region": "us-west-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": "Live mirror", "on": "CLICK", "refs": [ "refs/heads/master" ], "last_execution_status": "SUCCESSFUL", "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08" } }
STATUS
201 Created