BuildMaster Health API
  • 08 Feb 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

BuildMaster Health API

  • Dark
    Light
  • PDF

Article summary

The Get BuildMaster Health is an endpoint that will return a BuildMasterHealth object describing the health of a BuildMaster instance.

Using this endpoint does not require an API key and can be accessed by simply adding /health to your BuildMaster URL (e.g. https://proget.corp.local/health)

🚀 Quick Example: Get the Health of a BuildMaster Instance with Curl

This example will get the health of a BuildMaster instance with the URL proget.corp.local:

curl -H "Content-Type: application/json" -X GET https://proget.corp.local/health

Request Specification

To return the health status of a BuildMaster instance, simply GET to the URL.

GET /health

Response Specification

A successful (200) response body will return an BuildMasterHealth object. For example, to querying the health of a BuildMaster instance, the request would return this:

GET /health

{
  "applicationName": "BuildMaster",
  "databaseStatus": "OK",
  "databaseStatusDetails": null,
  "extensionsInstalled": {
    "BuildMaster Core Extensions": "23.0.9",
    "BuildMaster": "23.0.9",
    "Inedo.SDK": "2.4.0",
    "Azure": "2.0.1",
    "AzureDevOps": "2.4.0",
    "Bitbucket": "2.4.0",
    "Docker": "2.4.3",
    "DotNet": "2.2.7",
    "Git": "2.4.0",
    "Gitea": "2.4.0",
    "GitHub": "2.4.2",
    "GitLab": "2.4.0",
    "InedoCore": "2.4.0",
    "Java": "2.2.0",
    "Jenkins": "2.4.0",
    "Jira": "2.4.2",
    "Node": "2.2.0",
    "Python": "2.2.0",
    "Scripting": "2.4.0",
    "TeamCity": "2.4.0",
    "Windows": "2.0.3"
  },
  "instanceName": null,
  "licenseStatus": "OK",
  "licenseStatusDetail": null,
  "versionNumber": "2023.9 (Build 1)",
  "releaseNumber": "23.0.9",
  "serviceStatus": "OK",
  "serviceStatusDetail": null
}
ResponseDetails
200 (Success)body will contain a BuildMasterHealth object
500 (Server Error)indicates an unexpected error; the body will contain the message and stack trace, and this will also be logged

BuildMasterHealth Object Attributes

BuildMasterHealth is a set of key/value pairs that describe the health status of a ProGet instance. It's used as output data for the Get BuildMaster Health endpoint as a JSON-formatted object.

PropertyFormatNotes
applicationNamestringFor this API it will be BuildMaster as default
databaseStatusstringhealth state of the database. (OK or Error)
databaseStatusDetailsstring?a specific error message if databaseStatus is Error (default null)
extensionsInstalledobjectdescribes the extentions installed in the instance and their versions (e.g. "Azure": "2.0.1")
instanceNamestring?the name of the instance (default null)
licenseStatusstringhealth state of the product license. (OK or Error)
licenseStatusDetailstring?a specific error message if licenseStatus is Error (default null)
versionNumberstringcurrent version number of the instance
releaseNumberstringcurrent release number of the instance
serviceStatusstringhealth state of the service. (OK or Error)
serviceStatusDetailstring?a specific error message if serviceStatus is Error (default null)

Was this article helpful?