Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Updating the Cache for a Web Tamper Protection Rule

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

View PDF

Updating the Cache for a Web Tamper Protection Rule

Function

This API is used to updating the cache for a web tamper protection Rule.

URI

POST /v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}/refresh

**Table 1** Path Parameters
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.
rule_id	Yes	String	Rule ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	You can obtain the ID by calling the ListEnterpriseProject API of EPS.

Request Parameters

**Table 3** Request header 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

Response Parameters

Status code: 200

**Table 4** Response body parameters
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. 0: The rule is disabled. 1: The rule is enabled.
timestamp	Long	Timestamp the rule was created.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

The following example shows how to update cache for a web tamper protection rule. The project ID is specified by project_id, the policy ID is specified by policy_id, and the rule ID is specified by rule_id.

POST https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antitamper/{rule_id}/refresh?

Example Responses

Status code: 200

{
  "description" : "",
  "hostname" : "www.domain.com",
  "id" : "0f59185b76c143f884d21cd0d88e6fa8",
  "policyid" : "1f016cde588646aca3fb19f277c44d03",
  "status" : 1,
  "timestamp" : 1666506256928,
  "url" : "/login"
}