Internet Explorer is no longer supported. Many things will still work, but your experience will be degraded and some things won't function. Please use a modern browser such as Edge, Chrome, or Firefox.

Create/Update Project

view on GitHub

Create/Update Project is available as both a pgutil command and an HTTP Request, and will create a new project or update properties on an existing project, and return a ProjectInfo Object object describing the new or updated project.

Note: this API endpoint functions by creating a new project when the one specified in the API request does not exist, else it updates an existing project.

Command Specification (CLI)

The builds projects create command is used to create a new project or update an existing project.

The --project option is always required. The --type and --url options are optional. They can be included in the initial creation of a project, or to update an existing project

Creating a project requires the project name (e.g. myProject)

pgutil builds projects create --project=myProject

Updating the URL of a project requires the project name (e.g. myApplication) and the URL (e.g. proget.corp.local)

pgutil builds projects create --project=myApplication --url=proget.corp.local

HTTP Request Specification

To create or update a project, simply POST to the URL with an appropriate API Key and a ProjectInfo Object object as the request body.

POST /api/sca/projects

HTTP Response Specification

A successful (200) response body will contain a ProjectInfo Object object. For example, to creating a new project myProject, the request would return this:

POST /api/sca/projects
{ 
  "id":1,
  "name":"myProject"
}
Response Details
200 (Success) body will contain a ProjectInfo object
400 (Invalid Input) indicates invalid or missing properties on the ProjectInfo 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