Adding a Protection Policy

Function

This API is used to add a protection 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

POST /v5/{project_id}/ransomware/protection/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 contains 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
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
policy_name	Yes	String	Policy name
protection_mode	Yes	String	Action. Its value can be: alarm_and_isolation: Report an alarm and isolate. alarm_only: Only report alarms.
deploy_mode	No	String	Whether to enable dynamic honeypots. The options are as follows. By default, dynamic honeypot protection is disabled. opened closed
protection_directory	Yes	String	Protected directory. Separate multiple directories with semicolons (;). You can configure up to 20 directories.
protection_type	Yes	String	Definition Types of files to be protected. Constraints N/A Range txt, csv, rtf, doc, docx, xls, xlsx, ppt, pptx, pdf, xml, json, sql, mdf, dbf, ldf, db, myd, wdb, si, cfs, cfe, fnm, fdx, fdt, tvx, tvf, tvd, tim, nvd, nvm, dvd, dvm, jpeg, bmp, gif, png, tiff, eps, mp3, mp4, avi, mpg, wmv, RMVB, mov, 3pg, swf, flv, rar, gz, tgz, zip, 7z, cpp, c, java, asp, php, python, html, js, vdi, vmdk, vdx, ovf, qcow2, vmem, vswp, img, bak, back, cer, crt, pem, key, csr Default Value N/A
exclude_directory	No	String	(Optional) Excluded directory. Separate multiple directories with semicolons (;). You can configure up to 20 directories.
operating_system	Yes	String	OS. Its value can be: Windows Linux
process_whitelist	No	Array of TrustProcessInfo objects	Process whitelist
ai_protection_status	No	String	Definition Whether to enable AI ransomware protection. Constraints N/A Range The options are as follows: opened closed Default Value closed

**Table 5** TrustProcessInfo
Parameter	Mandatory	Type	Description
path	No	String	Definition Process path. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
hash	No	String	Definition Process hash. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Modify the ransomware protection policy. Set the OS type to Linux, protection policy ID to 0253edfd-30e7-439d-8f3f-17c54c997064, and protection action to alert only.

{
  "policy_name" : "liuzhaolingtest",
  "protection_mode" : "alarm_only",
  "deploy_mode" : "opened",
  "protection_directory" : "/root",
  "protection_type" : "txt",
  "operating_system" : "Linux"
}