Updated on 2026-04-03 GMT+08:00

Modifying a Whitelist Policy

Function

This API is used to modify a whitelist policy.

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

PUT /v5/{project_id}/app/policy

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

Yes

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

Length: 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

policy_id

Yes

String

Policy ID

policy_name

Yes

String

Policy name

policy_type

Yes

String

Definition

Process whitelist policy type.

Range

  • block: conservative mode

learning_days

Yes

Integer

Definition

Policy learning period (days).

Range

Minimum value: 3; maximum value: 30

specified_dir

No

Boolean

Definition

Whether to specify a directory for learning.

Constraints

N/A

Range

  • true: Yes

  • false: No

Default Value

N/A

intercept

Yes

Boolean

Definition

Whether to enable blocking.

Range

  • true: Yes

  • false: No

auto_confirm

Yes

Boolean

Definition

Whether to automatically confirm learning results.

Range

  • true: Yes

  • false: No

auto_detect

Yes

Boolean

Definition

Whether to automatically enable detection.

Range

  • true: Yes

  • false: No

dir_list

No

Array of strings

Monitoring directory list

ext_list

No

Array of strings

List of monitored file name extension

host_id_list

Yes

Array of strings

Server ID list

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Modify whitelist policy 111. Set the policy ID to 111xxxxxxxxxxxxxxx, policy type to block, policy learning days to 3, enable blocking, enable detection, automatically confirm the learning result, and set the server ID list to 0407b315-4a32-4dca-962e-abfead700ff6.

{
  "policy_id" : "111xxxxxxxxxxxxxxx",
  "policy_name" : "111",
  "policy_type" : "block",
  "learning_days" : 3,
  "intercept" : true,
  "auto_detect" : true,
  "auto_confirm" : true,
  "host_id_list" : [ "0407b315-4a32-4dca-962e-abfead700ff6" ]
}

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.