Modifying Ransomware Protection Policies

Function

This API is used to modify ransomware protection policies.

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}/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_id	Yes	String	Definition ID of a protection policy to be modified. You can obtain the ID by calling the API for Querying the Ransomware Protection Policy List. Constraints N/A Range The value can contain 0 to 128 characters. Default Value N/A
policy_name	Yes	String	Definition Policy Name Constraints N/A Range The value contains 0 to 128 characters. Default Value N/A
protection_mode	Yes	String	Definition Protective Actions Constraints N/A Range There are two types: alarm_and_isolation: Report an alarm and isolate. alarm_only: Only report alarms. Default Value N/A
bait_protection_status	No	String	Definition Whether to enable honeypot protection Constraints N/A Range opened Default Value N/A
deploy_mode	No	String	Definition Whether to enable dynamic honeypots. Constraints N/A Range The options are as follows: opened closed Default Value** closed
protection_directory	Yes	String	Definition Protected directory. Constraints Separate multiple directories with semicolons (;). You can configure up to 20 directories. Range The value can contain 0 to 128 characters. Only the following special characters are allowed: ._+-. The value cannot start with a space. Up to 256 characters are allowed. Default Value N/A
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	Definition (Optional) Excluded directory. Constraints Separate multiple directories with semicolons (;). You can configure up to 20 excluded directories. Range The value can contain 0 to 128 characters. Only the following special characters are allowed: ._+-. The value cannot start with a space. Up to 256 characters are allowed. Default Value N/A
agent_id_list	No	Array of strings	Definition IDs of the agents for which the ransomware protection policy is enabled. Constraints N/A Range The maximum number of items in the list is 1,000. Default Value N/A
operating_system	Yes	String	Definition Operating systems that support the policy Constraints N/A Range There are two types: Windows Linux Default Value N/A
runtime_detection_status	No	String	Definition Whether to perform runtime checks. Constraints N/A Range The options are as follows. Currently, it can only be disabled. This field is reserved. opened closed Default Value N/A
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 N/A

**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.

PUT https://{endpoint}/v5/{project_id}/ransomware/protection/policy

{
  "bait_protection_status" : "opened",
  "protection_type" : "docx",
  "exclude_directory" : "",
  "operating_system" : "Linux",
  "policy_id" : "0253edfd-30e7-439d-8f3f-17c54c997064",
  "policy_name" : "aaa",
  "protection_mode" : "alarm_only",
  "protection_directory" : "/root",
  "runtime_detection_status" : "closed",
  "agent_id_list" : [ "" ]
}