Adding an Image to the Whitelist

This API is used to add an image to the whitelist. Currently, only the vulnerability whitelist is supported.

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.

POST /v5/{project_id}/image/whitelists

**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.
global_image_type	Yes	String	Definition Image type. Constraints N/A Range local: local image registry: repository image Default Value N/A
type	Yes	String	Definition Whitelist type. Constraints N/A Range vulnerability: vulnerability whitelist Default Value N/A

**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	No	String	Definition Vulnerability type (used only when the vulnerability whitelist is queried) Constraints N/A Range linux_vul: Linux vulnerability app_vul: application vulnerability Default Value N/A
vul_ids	No	Array of strings	Vulnerability ID list (used only when a vulnerability whitelist is added)
rule_type	Yes	String	Definition Whitelist rule type. Constraints N/A Range all_images: The whitelist is applied to all images. specific_image_types: The whitelist is applied to the specified image types (only supported for specified repository types). specific_images: The whitelist is applied to the specified images. Default Value N/A
query_info	No	query_info object	Specifying an image based on the image query criteria
image_info	No	Array of image_info objects	Specified image
description	No	String	Description of the whitelist.

**Table 5** query_info
Parameter	Mandatory	Type	Description
image_type	No	String	Definition Image type. Constraints N/A Range private_image: private image repository shared_image: shared image repository instance_image: enterprise repository harbor: Harbor repository jfrog: JFrog repository Default Value N/A

**Table 6** image_info
Parameter	Mandatory	Type	Description
id	No	Long	Definition Repository image ID Constraints N/A Range Minimum value: 1; maximum value: 9223372036854775807 Default Value N/A
image_id	No	String	Definition Local image ID Constraints N/A Range Length: 0 to 64 characters Default Value N/A
image_name	No	String	Definition Image name. Constraints N/A Range Length: 1 to 256 characters Default Value N/A
image_type	No	String	Definition Image type. Constraints N/A Range local_image: local image private_image: private image repository shared_image: shared image repository instance_image: enterprise repository harbor: Harbor repository jfrog: JFrog repository Default Value N/A