Windows

POST Parameters

List with common parameters for all Buddy actions

Name	Type	Description
name `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `NATIVE_BUILD_WINDOWS`.
working_directory `Required`	String	The directory in which the pipeline filesystem will be mounted.
commands `Required`	String[]	The commands that will be executed.
execute_every_command	Boolean	If set to `true` all commands will be executed regardless of the result of the previous command.
sync_paths	SyncPath[]	Define file paths that should be copied before `PIPELINE_TO_VM` and after the execution `VM_TO_PIPELINE`.
vm_from_prev_action	Boolean	Set to `true` if you want the action to use the VM from the previous Windows action.
vm_action_name	String	The name of the action from which the VM is reused (if `vm_from_prev_action` is set to `true`). If not set, the previous one will be used.
distribution	String	Defines the image used to create the VM. Use `WINDOWS_SERVER_2019` for the default image, `AMI` for a custom `AMI`.
ami	Ami	Set if `distribution` is set to `AMI`.

Ami Properties

Name	Type	Description
id	String	Defines the AMI ID of the image. Ohio- and Stockholm-region images only.
password	String	Administrator password from the given Ami.

Example

Request

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

JSON

{
  "name": "Execute: msbuild",
  "type": "NATIVE_BUILD_WINDOWS",
  "trigger_time": "ON_EVERY_EXECUTION",
  "working_directory": "c:\\windows",
  "commands": [
    "nuget restore",
    "msbuild"
  ],
  "execute_every_command": true,
  "distribution": "AMI",
  "ami": 
    {
      "image": "ami-00bf6b81ba0081ada",
      "password": "pass-to-admin"
    },
  "sync_paths": [
    {
      "pipeline_path": "/",
      "vm_path": "c:\\buddy",
      "direction": "PIPELINE_TO_VM"
    },
    {
      "pipeline_path": "/",
      "vm_path": "c:\\buddy",
      "direction": "VM_TO_PIPELINE"
    }
  ]
}

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/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
  "id": 2,
  "name": "Execute: msbuild",
  "type": "NATIVE_BUILD_WINDOWS",
  "trigger_time": "ON_EVERY_EXECUTION",
  "working_directory": "c:\\windows",
  "commands": [
    "nuget restore",
    "msbuild"
  ],
  "execute_every_command": true,
  "distribution": "AMI",
  "ami": 
    {
      "image": "ami-00bf6b81ba0081ada"
    },
  "sync_paths": [
    {
      "pipeline_path": "/",
      "vm_path": "c:\\buddy",
      "direction": "PIPELINE_TO_VM"
    },
    {
      "pipeline_path": "/",
      "vm_path": "c:\\buddy",
      "direction": "VM_TO_PIPELINE"
    }
  ],
  "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"
  }
}

Last modified on November 29, 2022

Windows

Ami Properties

Knowledge is power!