This API is used to delete a geolocation access control rule.
DELETE /v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID |
policy_id |
Yes |
String |
Policy ID. It can be obtained by calling the ListPolicy API. |
rule_id |
Yes |
String |
ID of the geolocation access control rule. It can be obtained by calling the ListGeoipRules API. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token |
Content-Type |
No |
String |
Content type Default: application/json;charset=utf8 |
Status code: 200
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID. |
policyid |
String |
Policy ID |
name |
String |
Rule name. Currently, the console does not support configuring names for geolocation access control rule. Ignore this parameter. |
geoTagList |
Array of strings |
List of geographical locations hit the geolocation access control rule. |
geoip |
String |
Applicable regions. The value can be the region code.
|
white |
Integer |
Protective action. The value can be:
|
status |
Integer |
Rule status. The value can be:
|
timestamp |
Long |
Time the rule is created. The value is a 13-digit timestamp in ms. |
description |
String |
Rule description |
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 |
DELETE https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/geoip/{rule_id}?enterprise_project_id=0
Status code: 200
Request succeeded.
{ "id" : "02dafa406c4941368a1037b020f15a53", "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d", "name" : "demo", "timestamp" : 1650534513775, "description" : "demo", "status" : 1, "geoTagList" : [ "BR" ], "geoip" : "BR", "white" : 0 }
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
See Error Codes.