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 Issues

view on GitHub

List Issues is available as both a pgutil command and an HTTP Request, and will return an array of IssueInfo Object objects describing all issues in a project release.

Note, that if there are no issues in a release, an empty array is returned.

Command Specification (CLI)

The builds issues list command is used to list all existing issues in a project's build.

The --project and --build options are always required.

Listing issues requires the project (e.g. myProject) and the build version (e.g. 1.2.3)

pgutil builds issues list --project=myProject --build=1.2.3

Example output:

#1 -  because of Vulnerability (PGV-2245804), Package Status (Unlisted, Deprecated) is unknown, No license detected.

HTTP Request Specification

To list all issues of a release, simply GET to the URL with an appropriate API Key.

GET /api/sca/issues?project=«projectName»&version=«releaseVersion»

Listing issues requires the project name (e.g. myProject) and version (e.g. 1.0.0):

GET /api/sca/issues?project=myProject&version=1.2.3

HTTP Response Specification

A successful (200) response body will contain an array of IssueInfo Object objects. For example, to listing all issues in release version 1.2.3 of a project myProject, the request would return this:

GET /api/sca/issues?project=myProject&version=1.2.3

[
  {
    "number":1,
    "created":"2024-02-09T07:50:09.52Z",
    "type":"L",
    "purl":"pkg:nuget/Newtonsoft.Json@5.0.8"
  },
  {
    "number": 2, 
    "created": "2024-01-23T12:00:00Z", 
    "type": "V", 
    "purl": "pkg:myGroup/myPackage@v1.2.3", 
    "vulnerability": "12345"
  }
  {...}
]
Response Details
200 (Success) body will contain an array of IssueInfo 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
404 (Project Not Found) indicates that the specified project does not exist
500 (Server Error) indicates an unexpected error; the body will contain the message and stack trace, and this will also be logged