Docs
api
Web Application Firewall(UEWAF)
AddWafProtectionRuleInfo

Add WAF Protection Rules - AddWafProtectionRuleInfo

Overview

Add WAF Protection Rules

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is AddWafProtectionRuleInfo.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
ProjectIdstringProject ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface.No
RuleNumintNumber of Rule Matching ConditionsYes
RuleNamestringRule NameYes
RuleActionstringThe action after the rule is hit, Deny: Intercept, AcceptYes
RiskRankstringRisk Level, Low: Low, Middle: Medium, High: HighYes
FullDomainstringDomain name to add protection rulesYes
Rule.NstringRule matching conditions, for example: Field:UserAgent, Operator:Contain, Content:xxxxYes
RiskTypestringTypes of risks; Optional values: scan, loopholes, xss, cc, sql, exec, webshell, infoleak, eaa, protocol, otherNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
IdintThe ID of the protection rule returned after successful additionNo

Example

Request Example

https://api.dezai.com/?Action=AddWafProtectionRuleInfo
&ProjectId=org-xxx
&FullDomain=www.test.com
&RuleNum=1
&RuleName=test
&RuleAction=Deny
&RiskRank=Low
&RiskType=scan
&Rule.0=Field:SrcIp,Operator:Contain,Content:2.2.2.2

Response Example

{
  "Action": "AddWafProtectionRuleInfoResponse",
  "Id": 9,
  "RetCode": 0
}