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.
 
No matching results found

Assess Vulnerabilities

view on GitHub

Assess Vulnerabilities is available as both a pgutil command and an HTTP Request, and will assess a vulnerability according to the specified query arguments.

🚀 Quick Example: Auditing vulnerabilities in a project with pgutil

This example will assess the vulnerability PGV-1234567 as blocked:

pgutil vulns assess --id=PGV-1234567  --type=blocked

Command Specification (CLI)

The vulns assess command is used to assess a vulnerability.

The --id, and --type options are always required.

Assessing a vulnerability requires the vulnerability id (e.g. PGV-1234567) and assessment type (e.g. blocked):

pgutil vulns assess --id=PGV-1234567  --type=blocked  --comment="Package non-compliant" --policy=myPolicy

HTTP Request Specification

🔑 Authentication

If you disallow anonymous access to your feed, you will need to create an API Key that grants access to the Feed API. You will need to include that key as a header named X-ApiKey and set its value to that API key.

For example, to authenticate with the API key abc12345 to this endpoint, you could specify the API key as follows:

curl -X POST -H "X-ApiKey: abc12345" https://proget.corp.local/api/sca/assess

To assess a vulnerability, simply POST to the URL with a vulnerability id, assessment type, comment and policy parameters, and an appropriate API Key.

POST api/sca/assess[?id=«vulnerability-id»][&type=«assessment-type»][&comment=«comment»][&policy=«policy-name»]

Note that the comment and policy parameters are optional.

HTTP Response Specification

Response Details
200 (Success) the vulnerability was assessed
400 (Invalid Input) indicates invalid or missing properties in the request; 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
In this article

inedo.com | Support | MyInedo

docs © 2024 Inedo, LLC