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

Creating a Web Tamper Protection Rule

Function

This API is used to create a web tamper protection rule.

URI

POST /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.

Request Parameters

Table 2 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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

hostname

Yes

String

Protected website. It can be obtained by calling the ListHost API in cloud mode (the value of the hostname field in the response body).

url

Yes

String

URL protected by the web tamper protection rule. The value must be in the standard URL format, for example, /admin/xxx or /admin/. The asterisk () indicates the path prefix.

description

No

String

Rule description

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Rule ID

policyid

String

Policy ID

timestamp

Long

Timestamp (ms)

hostname

String

Domain name protected by the web tamper protection rule

url

String

URL protected by the web tamper protection rule

description

String

Description of the rule

status

Integer

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

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error Messages

Example Requests

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

{
  "hostname" : "www.domain.com",
  "url" : "/login",
  "description" : ""
}

Example Responses

Status code: 200

ok

{
  "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.