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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. To obtain it, go to Cloud management console and hover the cursor over your username. On the displayed window, choose My Credentials.Then, in the Projects area, view Project ID of the corresponding project. |
policy_id |
Yes |
String |
Policy ID. It can be obtained by calling the ListPolicy API. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
enterprise_project_id |
No |
String |
You can obtain the ID by calling the ListEnterpriseProject API of EPS. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API (value of X-Subject-Token in the response header). |
Content-Type |
Yes |
String |
Content type. Default: application/json;charset=utf8 |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
hostname |
Yes |
String |
Protected websites. The list 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
Parameter |
Type |
Description |
---|---|---|
id |
String |
Rule ID |
policyid |
String |
Policy ID |
hostname |
String |
Domain name protected by the web tamper protection rule |
url |
String |
URL protected by the web tamper protection rule |
description |
String |
Timestamp the rule was created. |
status |
Integer |
Rule status. The value can be 0 or 1.
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code |
error_msg |
String |
Error message |
Example Requests
The following example shows how to create a web tamper protection rule in a policy. The project ID is specified by project_id, and the policy ID is specified by policy_id. The website for the rule is www.demo.com, the URL of the rule is /test, and the rule description is demo.
POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antitamper?enterprise_project_id=0 { "hostname" : "www.demo.com", "url" : "/test", "description" : "demo" }
Example Responses
Status code: 200
Request succeeded.
{ "id" : "eed1c1e9c1b04b4bad4ba1186387a5d8", "policyid" : "38ff0cb9a10e4d5293c642bc0350fa6d", "description" : "demo", "status" : 1, "hostname" : "www.demo.com", "url" : "/test" }
Status Codes
Status Code |
Description |
---|---|
200 |
Request succeeded. |
400 |
Request failed. |
401 |
The token does not have required permissions. |
500 |
Internal server error. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.