Reviewing Whitelisted Vulnerability Options

Function

This API is used to query the vulnerability options added to the whitelist.

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

GET /v5/{project_id}/vulnerability/white-list/vulnerability-options

**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.
limit	Yes	Integer	Definition Number of records displayed on each page. Constraints N/A Range Value range: 10 to 200 Default Value 10
offset	No	Integer	Definition Offset, which specifies the start position of the record to be returned. Constraints N/A Range The value range is 0 to 2,000,000. Default Value The default value is 0.
category	No	String	Definition Category (If this parameter is not transferred, server vulnerabilities are queried by default.) Constraints N/A Range host: host vulnerability image: image vulnerability Default Value host
image_type	No	String	Definition Image type. This parameter is mandatory when category is set to image. Constraints N/A Range local_image: local image registry: repository image Default Value N/A
vul_type	No	String	Definition Vulnerability type. Constraints N/A Range linux_vul: Linux vulnerabilities windows_vul: Windows vulnerabilities web_cms: Web-CMS vulnerabilities app_vul: application vulnerabilities Default Value linux_vul
vul_name	No	String	Definition Vulnerability name. Constraints N/A Range The value contains 0 to 256 characters. Default Value N/A

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

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
total_num	Integer	Definition Total number. Range Minimum value: 0; maximum value: 2147483647
data_list	Array of data_list objects	Definition Vulnerability list. Range The value range is 0 to 2,147,483,647.

**Table 5** data_list
Parameter	Type	Description
vul_id	String	Definition Vulnerability ID. Range The value contains 0 to 256 characters.
vul_name	String	Definition Vulnerability name. Range The value contains 0 to 256 characters.

Example Requests

Query the vulnerability options in the whitelist whose project ID is 2b31ed520xxxxxxebedb6e57xxxxxxxx. The vulnerability name contains UNS.

GET https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/vulnerability/white-list/vulnerability-options?limit=30&vul_name=UNS&vul_type=linux_vul&category=host&enterprise_project_id=all_granted_eps

Example Responses

Status code: 200

Request succeeded.

{
  "total_num" : 4,
  "data_list" : [ {
    "vul_id" : "ELSA-2022-5095",
    "vul_name" : "ELSA-2022-5095 - grub2, mokutil, shim, and shim-unsigned-x64 security update"
  }, {
    "vul_id" : "KYSA-202109-1001",
    "vul_name" : "KYSA-202109-1001 Hunspell Vulnerability"
  }, {
    "vul_id" : "RHSA-2022:5095",
    "vul_name" : "RHSA-2022:5095 Red Hat Security Advisory: grub2, mokutil, shim, and shim-unsigned-x64 security update"
  }, {
    "vul_id" : "RHSA-2022:5096",
    "vul_name" : "RHSA-2022:5096 Red Hat Security Advisory: grub2, mokutil, shim, and shim-unsigned-x64 security update"
  } ]
}