Querying Image Vulnerability Information

Function

This API is used to query image vulnerability information.

Calling Method

For details, see Calling APIs.

URI

GET /v5/{project_id}/image/{image_id}/vulnerabilities

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant project ID
image_id	Yes	String	Image ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Enterprise project ID. To query all enterprise projects, set this parameter to all_granted_eps.
image_type	Yes	String	Image type. The options are as follows: private_image: private image repository shared_image: shared image repository
offset	No	Integer	Offset, which specifies the start position of the record to be returned. The value must be a number no less than 0. The default value is 0.
limit	No	Integer	Number of records displayed on each page.
instance_id	No	String	Enterprise repository instance ID. This API is not required for SWR shared edition.
namespace	Yes	String	Organization name
image_name	Yes	String	Image name
tag_name	Yes	String	Image tag
repair_necessity	No	String	Risk level. The options are as follows: immediate_repair: high risk delay_repair: medium risk not_needed_repair: low risk
vul_id	No	String	Vulnerability ID (fuzzy search supported)
app_name	No	String	Software
type	No	String	Vulnerability type. The options are as follows: -linux_vul: Linux vulnerability -app_vul: application vulnerability

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
x-auth-token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Total number of image vulnerabilities
data_list	Array of ImageVulInfo objects	Image vulnerability list

**Table 5** ImageVulInfo
Parameter	Type	Description
vul_id	String	Vulnerability ID
repair_necessity	String	Emergency level. Its values and their meanings are as follows: immediate_repair: high risk delay_repair: medium risk not_needed_repair: low risk
description	String	Vulnerability description
position	String	Image where a vulnerability exists
app_name	String	Vulnerability software name
app_path	String	Path of the application software (This field is available only for application vulnerabilities.)
version	String	Software version
solution	String	Solution
url	String	Patch address

Example Requests

Query the vulnerability information of the private image whose namespace is scc_hss_container, image name is apptest, and image version is V1.

GET https://{endpoint}/v5/{project_id}/image/{image_id}/vulnerabilities?limit=10&offset=0&namespace=scc_hss_container&tag_name=v1&image_name=apptest&image_type=private_image&type=linux_vul&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Image vulnerability list

{
  "total_num" : 1,
  "data_list" : [ {
    "app_name" : "xz-lib",
    "description" : "online",
    "position" : "sha256:74ddd0ec08fa43dXXXX",
    "repair_necessity" : "delay_repair",
    "solution" : "To upgrade the affected software",
    "url" : "https://access.redhat.com/errata/RHSAXXX",
    "version" : "5.2.4-3.el8",
    "vul_id" : "RHSA-2022:49XX"
  } ]
}