docs
api
Web Application Firewall(UEWAF)
DescribeWafResponseFilter

Query Information Security Filtering Rules - DescribeWafResponseFilter

Overview

Query Information Security Filtering Rules

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeWafResponseFilter.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, and the sub-account must be filled in. Please refer to the GetProjectList interface.No
FullDomainstringDomain to queryYes

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
Dataarray[HttpReponseFilter]Information security filter rule list, refer to HttpReponseFilterYes

Data Model

HttpReponseFilter

Field NameTypeDescription InformationRequired
IDintRule IDNo
NamestringRule NameNo
TypestringProtection type; Optional: Status (Status code), Sensitive (Sensitive content), Customize (Custom string)No
ContentstringFilter ContentNo
RuleActionstringDiscard response or disguise contentNo
DisguiseFilestringFake Response ContentNo

Example

Request Example

https://api.surfercloud.com/?Action=DescribeWafResponseFilter
&ProjectId=org-xxx
&FullDomain=www.test.com

Response Example

{
  "Action": "DescribeWafHttpResponseFilterResponse",
  "Data": [
    {
      "Content": "TelNum",
      "DisguiseFile": "",
      "ID": 3000,
      "Name": "手机号",
      "RuleAction": "DROP",
      "Type": "Sensitive"
    },
    {
      "Content": "403",
      "DisguiseFile": "403403",
      "ID": 2000,
      "Name": "43",
      "RuleAction": "DISGUISE",
      "Type": "Status"
    },
    {
      "Content": "404",
      "DisguiseFile": "",
      "ID": 1000,
      "Name": "404",
      "RuleAction": "DROP",
      "Type": "Status"
    }
  ],
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved