BuildMaster Application Management API

The Application Management API has Endpoints to help list, create, update, and purge applications, and are intended to automate the setup and management of applications in your BuildMaster instance:

• Create Application Endpoint - Create a blank application

• Clone Application Endpoint - Clones an existing application

• Import Application Endpoint - Create an application from an exported package

• Update Application Endpoint - Update an existing application

• Purge Application Endpoint - Purge an existing application

• List Application Endpoint - Lists all existing applications

Authentication

An API Key with the Application Management 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 --header "X-ApiKey: a1b2c3d4e5" "https://proget.corp.local/api/applications/create"

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

Data Specifications

ApplicationInfo Object

ApplicationInfo is a set of key/value pairs that correspond to the fields on the Application > Basic Settings and Advanced Settings pages. It's used as both input and output data for various endpoints:

• Output: The Create, Update, and List Application Endpoints return ApplicationInfo as a JSON-formatted object; all values are returned

• Input: The Create, and Update Application Endpoints receive ApplicationInfo as either a JSON-formatted object, querystring parameter, or form-encoded data; a missing property indicates that the value should not be updated

Note that some values are optional (indicated by string?), and may be set to null or an empty string.

JSON Object:

{
  "id": 123,
  "name": "myApplication",
  "description": "This is a sample application.",
  "groupName": myGroup,
  "active": true,
  "setupTemplate": "BasicSetup",
  "buildNumberScheme": "Sequential",
  "releaseUsage": "Required",
  "defaultReleaseTemplate": null,
  "allowIssues": true,
  "displayIssues": true,
  "displayPipelines": true,
  "displayScripts": true,
  "displayConfiguration": true,
  "displayDatabase": true,
  "buildPageDescription": "This page provides information about the build.",
  "artifactUsage": "FileSystem",
  "artifactAssetDirectory": null,
  "raft": "MainRaft"
}

CloneApplication Object

CloneApplication is a set of key/value pairs that provide direction on creating a new application. It's used as input for the Clone Application Endpoint.

This will behave the same as cloning that application from the UI.

JSON Object

{
  "name": "NewApplication",
  "from": "ExistingApplication",
  "raft": "CustomRaft"
}

ImportApplication Object

ImportApplication is a set of key/value pairs that provide direction on creating a new application. It's used as input for the Import Application Endpoint.

Depending on the value of the properties, this behaves like creating an application from a template, reapplying a template, creating a sample application, or restoring an application from a backup.

JSON Object:

{
  "name": "NewApplication",
  "packageSource": "MyUniversalFeed",
  "packageId": "com.example.myapp",
  "packageVersion": "1.0.0",
  "importHistory": true,
  "overwrite": false,
  "raft": null
}