List Application Endpoint
  • 09 Jan 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

List Application Endpoint

  • Dark
    Light
  • PDF

Article Summary

The List Application is an endpoint in BuildMaster's Application Management API that will return an array of ApplicationInfo objects listing all applications

🚀 Quick Example: Listing Applications with Curl

This example lists all applications, authenticating with the API key abc12345:

curl -X POST --header "X-ApiKey: abc12345" https://proget.corp.local/api/applications/list

Request Specification

To list all applications, simply POST to the URL with an appropriate API Key.

POST /api/applications/list

Response Specification

A successful (200) response body will contain an array of ApplicationInfo objects. For example, the request would return this:

POST /api/applications/list

[
  {
    "id":1,
    "name":"myApp1",
    "active":true,
    "groupName":"MyGroup"
    "buildNumberScheme":"Sequential",
    "releaseUsage":"Required",
    "allowIssues":false
  },
  {
    "id":2,
    "name":"myApp2",
    "active":true,
    "groupName":"OtherGroup"
    "buildNumberScheme":"DateTimeBased",
    "releaseUsage":"Required",
    "allowIssues":true
  },
  { ... } // other applications
]
ResponseDetails
200 (Success)body will contain an array of ApplicationInfo Object
403 (Unauthorized API Key)indicates a missing, unknown, or unauthorized API Key; the body will be empty
500 (Server Error)indicates an unexpected error; the body will contain the message and stack trace, and this will also be logged

Was this article helpful?