Handling Image Vulnerabilities

Function

This API is used to handle image vulnerabilities.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

POST /v5/{project_id}/image/vulnerability/handle

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
image_type	Yes	String	Definition Image type. Constraints N/A Range local: local image registry: repository image cicd : CI/CD image Default Value N/A
type	Yes	String	Definition Vulnerability type. Constraints N/A Range linux_vul: Linux vulnerability app_vul: application vulnerability Default Value N/A
operate_type	Yes	String	Definition Actions taken to handle the vulnerability Constraints N/A Range ignore: ignore not_ignore: unignore manual_repair: manual fix add_to_whitelist: whitelist Default Value N/A
handle_status	No	String	Definition Status of vulnerabilities to be handled Constraints N/A Range unhandled: vulnerability to be handled handled: handled vulnerabilities Default Value N/A
select_type	Yes	String	Definition Type of vulnerability handling scope Constraints N/A Range all_vul: Handle all vulnerabilities. specific_image_all_vul: Handle all the vulnerabilities of a specified image. specific_vul_all_image:: Handle all the images of a specified vulnerability. vul_view: Specify the vulnerabilities and images to be handled in the vulnerability dimension. image_view: Specify the vulnerabilities and images to be handled in the image dimension. Default Value N/A
image_id_list	No	Array of strings	Definition If select_type is set to specific_image_all_vul, this field specifies the ID list of images to be handled. Constraints This field is valid only when select_type is set to specific_image_all_vul. Range N/A Default Value N/A
vul_id_list	No	Array of strings	Definition ID list of vulnerabilities to be handled when select_type is set to specific_vul_all_image. Constraints This field is valid only when select_type is set to specific_vul_all_image. Range N/A Default Value N/A
vul_data_list	No	Array of vul_data_list objects	Definition When select_type is set to vul_view, this parameter specifies the vulnerabilities and images to be handled. Constraints This field is valid only when select_type is set to vul_view. Range N/A Default Value N/A
image_data_list	No	Array of image_data_list objects	Definition When select_type is set to image_view, this parameter specifies the vulnerabilities and images to be handled. Constraints This parameter is valid only when select_type is set to image_view. Range N/A Default Value N/A
remark	No	String	Definition Description of the handling operation. Constraints N/A Range Length: 0 to 512 characters Default Value N/A

**Table 5** vul_data_list
Parameter	Mandatory	Type	Description
vul_id	No	String	Definition Vulnerability ID. Constraints N/A Range Length: 0 to 128 characters Default Value N/A
image_id_list	No	Array of strings	Definition List of image IDs. Constraints N/A Range N/A Default Value N/A

**Table 6** image_data_list
Parameter	Mandatory	Type	Description
image_id	No	String	Definition Image ID. Constraints N/A Range Length: 0 to 512 characters Default Value N/A
vul_id_list	No	Array of strings	Definition Vulnerability ID list. Constraints N/A Range N/A Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Ignore all unhandled Linux vulnerabilities in the local images of the project whose project_id is 2b31ed520xxxxxxebedb6e57xxxxxxxx.

POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/image/vulnerability/handle?enterprise_project_id=all_granted_eps

{
  "image_type" : "local",
  "type" : "linux_vul",
  "operate_type" : "ignore",
  "handle_status" : "unhandled",
  "select_type" : "all_vul"
}