docs
api
Web Application Firewall(UEWAF)
DescribeAssurancePages

Get Anti-Tampering Page List - DescribeAssurancePages

Overview

Get Anti-Tampering Page List

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeAssurancePages.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
DomainstringDomain to be obtainedYes

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
ResAssurancePagesAnti-tampering information, refer to AssurancePagesNo

Data Model

AssurancePages

Field NameTypeDescription InformationRequired
StatestringUGuard Global StatusYes
TotalCountintTotal number of tamper-proof configurationsYes
LimitintAnti-Tampering Rule QuotaYes
Itemsarray[AssuracePagesDetail]Tamper-proof rule list, refer to AssuracePagesDetailYes

AssuracePagesDetail

Field NameTypeDescription InformationRequired
IdintAnti-Tampering Rule IDYes
UrlstringAnti-tampering page URLYes
StatestringProtection StatusYes
RemarkstringNote InformationNo

Example

Request Example

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

Response Example

{
  "Action": "DescribeAssurancePagesResponse",
  "Res": {
    "Items": [
      {
        "Id": 368,
        "Remark": "q",
        "State": "on",
        "Url": "http://www.test.com/inedx.html"
      }
    ],
    "Limit": 19,
    "State": "off",
    "TotalCount": 1
  },
  "RetCode": 0
}
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved