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.

List Projects

view on GitHub

List Projects is available as both a pgutil command and an HTTP Request, and will return an array of ProjectInfo Object objects describing all projects.

Command Specification (CLI)

The builds projects list command is used to list all existing projects.

Listing projects requires no additional options.

Example output:

myProject
anotherProject (Application)
yetAnotherProject (Application)
testApplication

HTTP Request Specification

To list all projects, simply GET to the URL with an appropriate API Key.

GET /api/sca/projects

HTTP Response Specification

A successful (200) response body will contain an array of ProjectInfo Object objects. For example, to listing all projects, the request would return this:

GET /api/sca/projects

[
  { 
    "id":1,
    "name":"myProject"
  },
  { 
    "id":2,
    "name":"anotherProject"
  },
  { 
    "id":3,
    "name":"yetAnotherProject"
  },
  {...}
]
Response Details
200 (Success) body will contain an array of ProjectInfo objects
400 (Invalid Input) indicates invalid or missing properties
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