List Issues
  • 21 Feb 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

List Issues

  • Dark
    Light
  • PDF

Article Summary

The List Issues is an endpoint in ProGet's SCA Directory API that 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.

šŸš€ Quick Example: Listing Issues with Curl

This example lists all issues in release version 1.2.3 of a project myProject, authenticating with the API key abc12345:

curl -X GET -H "X-ApiKey: abc12345" "https://proget.corp.local/api/sca/issues?project=myProject&version=1.2.3"

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Ā»

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"
  }
  {...}
]
ResponseDetails
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 or Release Not Found)indicates that the specified project
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?

What's Next