Create Application Endpoint
  • 16 Jan 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Create Application Endpoint

  • Dark
    Light
  • PDF

Article Summary

The Create Application is an endpoint in BuildMaster's Application Management API that will create a blank application and return an ApplicationInfo object describing the created application.

🚀 Quick Example: Creating an Application with Curl

This example creates an application newApp, authenticating with the API key abc12345:

curl -X POST --header "X-ApiKey: abc12345" https://proget.corp.local/api/applications/create?name=myNewApp

Request Specification

To create a blank application, simply POST to the URL with an appropriate API Key and a ApplicationInfo object as the request body.

POST /api/applications/create

Querystring parameters may be used for ApplicationInfo object properties instead of the Body

POST /api/applications/create?«ApplicationInfo-properties»

Creating an application with an ApplicationInfo body requires the name (e.g. myNewApp):

POST /api/applications/create
{
    "name": "myNewApp"
}

Creating an application with querystring parameters requires the name (e.g. myNewApp):

POST /api/applications/create?name=myNewApp

Response Specification

A successful (200) response body will contain an ApplicationInfo object. For example, to creating a blank application named myNewApp, the request would return this:

POST /api/applications/create

{
    "id":1,
    "name":"myNewApp",
    "active":true,
    "buildNumberScheme":"Sequential",
    "releaseUsage":"Required",
    "allowIssues":false
}
ResponseDetails
200 (Success)creates an application, the body will contain a ApplicationInfo Object
400 (Invalid Input)indicates invalid or missing properties on the ApplicationInfo Object; the body will provide some details as text
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?