BuildMaster Release & Build Deployment API

The Release & Build Deployment API offers a simple mechanism for creating releases, creating builds, and deploying builds.

This endpoint receives data entirely as key/value parameters, which may be specified in both the querystring and body (application/x-www-form-urlencoded); duplicate keys will result in a failed request (400 status).

All API endpoints are accessed through the following base URL:

🚀 Releases Endpoints

Create Release - Creates a release
Get Releases - Returns a list of all releases
Restore Release - Restores a release
Cancel Release - Cancels a release

🛠 Builds Endpoints

Create Build - Creates a build
Deploy Build - Deploys a build
Get Build - Returns a list of all builds
Reject Build - Rejects a build

⚙ Deployments Endpoint

Get Deployments - Returns a list of all deployments

Authentication

An API Key with the Release & Build Deployment permission is required to use this API.

It can be passed to each endpoint in one of four ways, depending on the content type of the expected request:

To specify an API Key, use the request header (X-ApiKey), querystring (key), or api:«api-key» as the user name. See API Access and API Key to learn more.

curl -X POST -H "X-ApiKey: a1b2c3d4e5" "/api/releases/builds/create"

The specified API key does not have the proper permissions to perform this action.

Data Specifications

ReleaseInfo Object Properties

ReleaseInfo is a set of key/value pairs that correspond to the fields on a Release. It's used as output data for the Create Release and Get Releases endpoints, returning ReleaseInfo as a JSON-formatted object.

JSON Object

{
    "id": 1,
    "number": "1.0.1",
    "name": "1.0.1",
    "sequence": 1,
    "status": "active",
    "createdBy": "MikeJones",
    "createdOn": "2024-03-04T09:03:43.9200000Z",
    "applicationId": 1,
    "applicationName": "ProfitCalculator",
    "pipelineName": "Release",
    "furthestBuildId": 3,
    "furthestBuildNumber": "2",
    "latestBuildId": 3,
    "latestBuildNumber": "2",
    "deployables": [],
    "furthestPackageId": 3,
    "furthestPackageNumber": "2",
    "latestPackageId": 3,
    "latestPackageNumber": "2",
    "releaseName": "1.0.1",
    "releaseNumber": "1.0.1"
}

BuildInfo Object Properties

BuildInfo is a set of key/value pairs that correspond to the fields on a Build. It's used as output data for the Create Build and Get Build endpoints, returning BuildInfo as a JSON-formatted object.

JSON Object

{
    "id": 1,
    "number": "3",
    "status": "active",
    "createdBy": "API",
    "createdOn": "2024-03-05T02:46:56.0800000Z",
    "applicationId": 2,
    "applicationName": "TaxCalculator",
    "pipelineName": "Release",
    "releaseId": 4,
    "releaseNumber": "1.0.1",
    "releaseName": "1.0.1",
    "buildNumber": "3"
}

DeploymentInfo Object Properties

DeploymentInfo is a set of key/value pairs that correspond to the fields on a Release. It's used as both input and output data for the Deploy Build and Get Deployments endpoints, returning DeploymentInfo as a JSON-formatted object.

{
    "id": 1,
    "plan": "Deploy",
    "status": "succeeded",
    "started": "2024-03-04T09:31:20.5100000Z",
    "ended": "2024-03-04T09:31:20.6100000Z",
    "createdBy": "SYSTEM",
    "createdOn": "2024-03-04T09:31:15.4900000Z",
    "pipelineName": "Release",
    "pipelineStageName": "Integration",
    "applicationId": 1,
    "applicationName": "TaxCalculator",
    "releaseId": 1,
    "releaseNumber": "1.0.1",
    "releaseName": "1.0.1",
    "buildId": 1,
    "buildNumber": "2",
    "packageId": 1,
    "packageNumber": "2"
}