Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com> Co-authored-by: qinweiwei <qinweiwei@huawei.com> Co-committed-by: qinweiwei <qinweiwei@huawei.com>
21 KiB
Updating a Known Attack Source Rule
Function
This API is used update a known attack source rule.
URI
PUT /v1/{project_id}/waf/policy/{policy_id}/punishment/{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 known attack source rule. It can be obtained by calling the ListPunishmentRules API. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
X-Auth-Token |
Yes |
String |
auth token |
Content-Type |
Yes |
String |
Content type. |
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
block_time |
Yes |
Integer |
Block duration, in seconds. If prefix long is selected for the rule type, the value for block_time ranges from 301 to 1800. If prefix short is selected for the rule type, the value for block_time ranges from 0 to 300. |
description |
No |
String |
Rule description |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
|---|---|---|
id |
String |
Rule ID |
policyid |
String |
Policy ID |
block_time |
Integer |
Block duration, in seconds. |
category |
String |
Type of the known attack source rule. |
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 |
Example Requests
PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/punishment/{rule_id}?
{
"category" : "long_ip_block",
"block_time" : "1233",
"description" : "update"
}
Example Responses
Status code: 200
Request succeeded.
{
"block_time" : 1233,
"category" : "long_ip_block",
"description" : "update",
"id" : "2c3afdcc982b429da4f72ee483aece3e",
"policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
"timestamp" : 1668148186106
}
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.