docs
api
Web Application Firewall(UEWAF)
ModifyWafDomainBlackList

Edit Domain Blacklist - ModifyWafDomainBlackList

Overview

Edit Domain Blacklist

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is ModifyWafDomainBlackList.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
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, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
IDintBlacklist Record IDYes
SourcestringBlacklist source, User-defined(custom)/Machine behavior detection(bot)/ bot-rule/ auto (automatic blocking rules)Yes
TypestringType: Domestic (internal), Overseas (oversea), Custom (custom)Yes
ActionTypestringAction: captcha/forbiddenYes
ExpireTimeintExpiration time, that is, the effective duration, the unit is seconds, pass 0 for never expire.Yes
FullDomainstringThe domain to which this record belongsYes
CIDRS.NstringIP, subnet or IP range, pass array; Required when type is customNo
RecordIdintDomain Record IDNo
RemarkstringNote InformationNo
NamestringThe name of this policyNo

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

Example

Request Example

https://api.surfercloud.com/?Action=ModifyWafDomainBlackList
&ProjectId=org-xxx
FullDomain=www.test.com
&ID=252731
&Type=custom
ActionType=forbidden
&CIDRS.0=2.2.2.2
&ExpireTime=0
&Remark=test
&Source=gstrulLO
&Name=VAuukXKz

Response Example

{
  "Action": "ModifyWafDomainBlackListResponse",
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved