Get Builds

The Get Builds is an endpoint in BuildMaster's Release & Build Deployment API that will return an array of BuildInfo objects describing builds in the instance, based on the specified optional filter parameters.

curl -X POST -H "X-ApiKey: abc12345" -H "Content-Type: application/json" -d "{\"status\": \"active\"}" "https://proget.corp.local/api/releases/builds"

Request Specification

GET/POST /api/releases/builds

To get a list of builds, simply GET or POST to the URL with an appropriate API Key and a request body, applying the following optional filter parameters:

Getting builds permits specified filters as the request body:

GET /api/releases/builds

{
  "status": "active"
}

Response Specification

A successful (200) response body will contain an array of BuildInfo objects. For example, getting all active build returns:

[
    {
        "id": 5,
        "number": "1",
        "status": "active",
        "createdBy": "MarkSmith",
        "createdOn": "2024-03-04T09:04:06.4930000Z",
        "applicationId": 2,
        "applicationName": "ProfitCalculator",
        "pipelineName": "Release",
        "furthestStage": "Build",
        "releaseId": 4,
        "releaseNumber": "1.0.1",
        "releaseName": "1.0.1",
        "buildNumber": "1"
    },
    {
        "id": 1,
        "number": "1",
        "status": "active",
        "createdBy": "JohnSmith",
        "createdOn": "2024-03-04T08:17:08.1000000Z",
        "applicationId": 1,
        "applicationName": "TaxCalculator",
        "releaseId": 3,
        "releaseNumber": "2.0.1",
        "releaseName": "2.0.1",
        "buildNumber": "1"
    },
    { ... }
]