Updated on 2024-07-25 GMT+08:00

Querying the List of Web Tamper Protection Rules

Function

This API is used for querying the list of web tamper protection rules.

URI

GET /v1/{project_id}/waf/policy/{policy_id}/antitamper

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

policy_id

Yes

String

Protection policy ID. You can call the ListPolicy API to obtain the policy ID.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

page

No

Integer

Page number of the data to be returned in a query. The value range is 0 to 100000. The default value is 1, indicating that data on the first page is returned.

Default: 1

pagesize

No

Integer

Number of results on each page in query pagination. The value range is 1 to 100. The default value is 10, indicating that each page contains 10 results.

Default: 10

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

auth token

Content-Type

Yes

String

Content type

Default: application/json;charset=utf8

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

total

Integer

Total

items

Array of AntiTamperRuleResponseBody objects

Rules

Table 5 AntiTamperRuleResponseBody

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

timestamp

Long

Timestamp (ms)

description

String

Description of the rule

status

Integer

Rule status. The value can be 0 (disabled) or 1 (enabled).

hostname

String

URL protected by the web tamper protection rule, excluding a domain name

url

String

URL protected by the web tamper protection rule

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 401

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Example Requests

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antitamper?enterprise_project_id=0

Example Responses

Status code: 200

ok

{
  "total" : 1,
  "items" : [ {
    "description" : "",
    "hostname" : "www.domain.com",
    "id" : "0f59185b76c143f884d21cd0d88e6fa8",
    "policyid" : "1f016cde588646aca3fb19f277c44d03",
    "status" : 1,
    "timestamp" : 1656506256928,
    "url" : "/login"
  } ]
}

Status Codes

Status Code

Description

200

ok

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.