Updating a Policy¶
Function¶
This API is used to update a policy. The request body can contain only the part to be updated.
URI¶
PATCH /v1/{project_id}/waf/policy/{policy_id}
Parameter | Mandatory | Type | Description |
|---|---|---|---|
project_id | Yes | String | Project ID |
policy_id | Yes | String | Policy ID. It can be obtained by calling the API Querying Protection Policies. |
Request Parameters¶
Parameter | Mandatory | Type | Description |
|---|---|---|---|
X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Content-Type | Yes | String | Content type. Default value: application/json;charset=utf8 Default: application/json;charset=utf8 |
Parameter | Mandatory | Type | Description |
|---|---|---|---|
name | No | String | Array of details of policies |
action | No | PolicyAction object | PolicyAction |
options | No | PolicyOption object | PolicyOption |
robot_action | No | Action object | Feature-based anti-crawler protection mode. This parameter is unavailable for newly created protection policies. The default protection mode is Log only. |
level | No | Integer | Protection level
|
full_detection | No | Boolean | Detection mode in the precise protection rule
|
Parameter | Mandatory | Type | Description |
|---|---|---|---|
category | No | String | Protection level. The value can be:
Enumeration values:
|
Parameter | Mandatory | Type | Description |
|---|---|---|---|
webattack | No | Boolean | Basic web protection includes many specific checks under Advanced Settings, and there is a specific parameter allocated for each check, for example, common for General Check. To enable any of these checks, keep this parameter enabled first. The value can be:
|
common | No | Boolean | Whether general check is enabled. The value can be:
|
anticrawler | No | Boolean | Whether to enable the JavaScript anti-crawler function.
|
crawler_engine | No | Boolean | Whether the search engine is enabled. The value can be:
|
crawler_scanner | No | Boolean | Whether the scanner check in anti-crawler detection is enabled. The value can be:
|
crawler_script | No | Boolean | Whether the JavaScript anti-crawler is enabled. The value can be:
|
crawler_other | No | Boolean | Whether other crawler check is enabled. The value can be:
|
webshell | No | Boolean | Whether webshell check is enabled. The value can be:
|
cc | No | Boolean | Whether the CC attack protection rule is enabled. The value can be:
|
custom | No | Boolean | Whether precise protection is enabled. The value can be:
|
whiteblackip | No | Boolean | Whether blacklist and whitelist protection is enabled. The value can be:
|
geoip | No | Boolean | Whether geolocation access control is enabled. The value can be:
|
ignore | No | Boolean | Whether false alarm masking is enabled. The value can be:
|
privacy | No | Boolean | Whether data masking is enabled. The value can be:
|
antitamper | No | Boolean | Whether the web tamper protection is enabled. The value can be:
|
antileakage | No | Boolean | Whether the information leakage prevention is enabled. The value can be:
|
followed_action | No | Boolean | Whether the Known Attack Source protection is enabled.. The value can be:
|
bot_enable | No | Boolean | Feature-based anti-crawler. This feature includes many specific anti-crawler checks, such as crawler_engine, crawler_scanner, crawler_script, and crawler_other. To enable any of these checks, keep anti-crawler protection enabled. The value can be:
|
crawler | No | Boolean | This parameter is reserved and can be ignored currently. |
precise | No | Boolean | This parameter is reserved and can be ignored currently. |
modulex_enabled | No | Boolean | This parameter is reserved and can be ignored currently. Enumeration values:
|
Parameter | Mandatory | Type | Description |
|---|---|---|---|
category | No | String | Protective action for feature-based anti-crawler rules:
Enumeration values:
|
Response Parameters¶
Status code: 200
Parameter | Type | Description |
|---|---|---|
id | String | Policy ID |
name | String | Array of details of policies |
action | PolicyAction object | PolicyAction |
options | PolicyOption object | PolicyOption |
level | Integer | Protection level
|
full_detection | Boolean | Detection mode in the precise protection rule
|
bind_host | Array of BindHost objects | Basic information about the protected domain. |
hosts | Array of strings | Array of IDs of protected domain names. The ID of a protected domain name is unique and generated by WAF when you add the domain name to WAF. To obtain the IDs, call the API Querying Domain Names Protected by Dedicated WAF Engines. To add a domain name to WAF, call the API Adding a Protected Domain Name. |
robot_action | Action object | Feature-based anti-crawler protection mode. This parameter is unavailable for newly created protection policies. The default protection mode is Log only. |
extend | PolicyExtend object | Switch for enabling or disabling Deep Inspection and Header Inspection in Basic Web Protection. |
share_info | ShareInfo object | Whether to share a policy. This parameter is reserved and can be ignored currently. |
modulex_options | ModulexOptions object | Whether to enabling intelligent CC protection. This parameter is reserved and can be ignored currently. |
timestamp | Integer | Time a policy is created |
Parameter | Type | Description |
|---|---|---|
category | String | Protection level. The value can be:
Enumeration values:
|
Parameter | Type | Description |
|---|---|---|
webattack | Boolean | Basic web protection includes many specific checks under Advanced Settings, and there is a specific parameter allocated for each check, for example, common for General Check. To enable any of these checks, keep this parameter enabled first. The value can be:
|
common | Boolean | Whether general check is enabled. The value can be:
|
anticrawler | Boolean | Whether to enable the JavaScript anti-crawler function.
|
crawler_engine | Boolean | Whether the search engine is enabled. The value can be:
|
crawler_scanner | Boolean | Whether the scanner check in anti-crawler detection is enabled. The value can be:
|
crawler_script | Boolean | Whether the JavaScript anti-crawler is enabled. The value can be:
|
crawler_other | Boolean | Whether other crawler check is enabled. The value can be:
|
webshell | Boolean | Whether webshell check is enabled. The value can be:
|
cc | Boolean | Whether the CC attack protection rule is enabled. The value can be:
|
custom | Boolean | Whether precise protection is enabled. The value can be:
|
whiteblackip | Boolean | Whether blacklist and whitelist protection is enabled. The value can be:
|
geoip | Boolean | Whether geolocation access control is enabled. The value can be:
|
ignore | Boolean | Whether false alarm masking is enabled. The value can be:
|
privacy | Boolean | Whether data masking is enabled. The value can be:
|
antitamper | Boolean | Whether the web tamper protection is enabled. The value can be:
|
antileakage | Boolean | Whether the information leakage prevention is enabled. The value can be:
|
followed_action | Boolean | Whether the Known Attack Source protection is enabled.. The value can be:
|
bot_enable | Boolean | Feature-based anti-crawler. This feature includes many specific anti-crawler checks, such as crawler_engine, crawler_scanner, crawler_script, and crawler_other. To enable any of these checks, keep anti-crawler protection enabled. The value can be:
|
crawler | Boolean | This parameter is reserved and can be ignored currently. |
precise | Boolean | This parameter is reserved and can be ignored currently. |
modulex_enabled | Boolean | This parameter is reserved and can be ignored currently. Enumeration values:
|
Parameter | Type | Description |
|---|---|---|
id | String | Domain name ID. It is the unique identifier generated by WAF for a domain name when you add the domain name to WAF |
hostname | String | Domain name |
waf_type | String | WAF mode of the domain name. The value is premium. |
Parameter | Type | Description |
|---|---|---|
category | String | Protective action for feature-based anti-crawler rules:
Enumeration values:
|
Parameter | Type | Description |
|---|---|---|
extend | String | Protection statuses for advanced settings in basic web protection. By default, this parameter is left blank, and the Deep Inspection and Header Inspection are disabled.
|
Parameter | Type | Description |
|---|---|---|
share_count | Integer | Total number of the users who share the address group. |
accept_count | Integer | Number of users who accept the sharing |
process_status | Integer | Status |
Parameter | Type | Description |
|---|---|---|
global_rate_enabled | Boolean | Status of the global rate limiting function (counting requests to all WAF instances when limiting traffic).
|
global_rate_mode | String | Protection mode of the global rate limiting function. WAF logs the event only.
Enumeration values:
|
precise_rules_enabled | Boolean | Status of the intelligent precise protection.
|
precise_rules_mode | String | Protection mode of the intelligent precise protection.
Enumeration values:
|
precise_rules_managed_mode | String | Management mode of the intelligent precise protection.
Enumeration values:
|
precise_rules_aging_mode | String | Aging mode of the intelligent precise protection.
Enumeration values:
|
precise_rules_retention | Integer | Maximum age of the intelligent precise protection. |
cc_rules_enabled | Boolean | Status of the intelligent CC attack protection.
|
cc_rules_mode | String | Protection mode of the intelligent CC attack protection rule.
Enumeration values:
|
cc_rules_managed_mode | String | Management mode of the intelligent CC attack protection.
Enumeration values:
|
cc_rules_aging_mode | String | Aging mode of the intelligent CC attack protection.
Enumeration values:
|
cc_rules_retention | Integer | Maximum age of the intelligent CC attack protection. |
Status code: 400
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code |
error_msg | String | Error message |
Status code: 401
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code |
error_msg | String | Error message |
Status code: 500
Parameter | Type | Description |
|---|---|---|
error_code | String | Error code |
error_msg | String | Error message |
Example Requests¶
PATCH https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}?
{
"options" : {
"whiteblackip" : true
}
}
Example Responses¶
Status code: 200
Request succeeded.
{
"id" : "38ff0cb9a10e4d5293c642bc0350fa6d",
"name" : "demo",
"level" : 2,
"action" : {
"category" : "log"
},
"options" : {
"webattack" : true,
"common" : true,
"crawler" : true,
"crawler_engine" : false,
"crawler_scanner" : true,
"crawler_script" : false,
"crawler_other" : false,
"webshell" : false,
"cc" : true,
"custom" : true,
"precise" : false,
"whiteblackip" : true,
"geoip" : true,
"ignore" : true,
"privacy" : true,
"antitamper" : true,
"anticrawler" : false,
"antileakage" : false,
"followed_action" : false,
"bot_enable" : true
},
"hosts" : [ "c0268b883a854adc8a2cd352193b0e13" ],
"timestamp" : 1650529538732,
"full_detection" : false,
"bind_host" : [ {
"id" : "c0268b883a854adc8a2cd352193b0e13",
"hostname" : "www.demo.com",
"waf_type" : "cloud"
} ],
"share_info" : {
"is_receiver" : false,
"provider_display" : {
"share_count" : 0,
"accept_count" : 0,
"process_status" : 0
}
}
}
Status Codes¶
Status Code | Description |
|---|---|
200 | Request succeeded. |
400 | Request failed. |
401 | The token does not have required permissions. |
500 | Internal server error. |
Error Codes¶
See Error Codes.