Deploy Build

The Deploy Build is an endpoint in BuildMaster's Release & Build Deployment API that will deploy a build, with the parameters defined in the body of the request. This endpoint will return a DeploymentInfo object.

curl -X POST -H "X-ApiKey: abc12345" -H "Content-Type: application/json" -d "{\"buildNumber\": \"2\", \"releaseNumber\": \"1.0.1\", \"applicationName\": \"TaxCalculator\"}" "https://proget.corp.local/api/releases/builds/deploy"

Request Specification

POST/PUT /api/releases/builds/deploy

To deploy a build, simply PUT or POST to the URL with an appropriate API Key and a request body, containing the following parameters:

Deploying a build requires parameters defined in the request body.

POST /api/releases/builds/deploy

{
  "buildNumber": "2",
  "releaseNumber": "5",
  "applicationName": "TaxCalculator"
}

Response Specification

A successful (200) response body will contain a single DeploymentInfo object. For example, deploying a build, with the applicationName of TaxCalculator returns:

{
    "id": 20,
    "plan": null,
    "status": "pending",
    "started": "2024-03-04T09:31:15.3470000Z",
    "ended": null,
    "createdBy": "API",
    "createdOn": "2024-03-04T09:31:15.3470000Z",
    "pipelineName": "Release",
    "pipelineStageName": "Integration",
    "applicationId": 2,
    "applicationName": "TaxCalculator",
    "releaseId": 4,
    "releaseNumber": "1.0.1",
    "releaseName": "1.0.1",
    "buildId": 6,
    "buildNumber": "2",
    "packageId": 6,
    "packageNumber": "2"
}