Adding Vulnerability Whitelist Entries

Function

This API is used to add a vulnerability whitelist item.

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}/vulnerability/white-list

**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
vul_type	Yes	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 N/A
vul_ids	Yes	Array of strings	Definition Vulnerability ID list. Constraints N/A Range Minimum value: 1; maximum value: 500 Default Value N/A
rule_type	Yes	String	Definition Whitelist rule type. Constraints N/A Range all_host: The whitelist applies to all servers. specific_host: The whitelist applies to a specified server. Default Value N/A
host_ids	No	Array of strings	Definition Server ID list. This parameter is mandatory when rule_type is set to specific_host. Constraints N/A Range Minimum value: 1; maximum value: 2000 Default Value N/A
with_ignore	No	Boolean	Definition Ignore Scanned Vulnerabilities Constraints N/A Range true: Ignore. false: Do not ignore. Default Value true
description	No	String	Definition Description of a whitelist. Constraints N/A Range Length: 0 to 1,000 characters Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Add a vulnerability whitelist item.

POST https://{endpoint}/v5/{project_id}/vulnerability/white-list?enterprise_project_id=all_granted_eps

{
  "vul_type" : "linux_vul",
  "vul_ids" : [ "Alpinev3.10-main-apk-tools-2.10.7-r0" ],
  "rule_type" : "specific_host",
  "description" : "description",
  "host_ids" : [ "b5d8f811-1be6-4630-8312-8513860e02cc" ]
}