Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Updating an Information Leakage Prevention Rule

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

View PDF

Updating an Information Leakage Prevention Rule

Function

This API is used to update an information leakage prevention rule.

URI

PUT /v1/{project_id}/waf/policy/{policy_id}/antileakage/{rule_id}

**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	Information leakage prevention rule ID. You can obtain it by calling the ListAntileakageRules API.

**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

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
url	Yes	String	URL to which the rule applies.
category	Yes	String	Type. The value can be code for response code or sensitive for sensitive information. Enumeration values: code sensitive
contents	Yes	Array of strings	Content. The value can be an HTTP status code, phone for mobile phone numbers, id_card for personal identity card number, and/or email for email addresses.
description	No	String	Rule description.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
id	String	Rule ID.
policyid	String	Policy ID.
url	String	URL to which the rule applies.
category	String	Type
contents	Array of strings	Value
status	Integer	Rule status. The value can be 0 or 1. 0: The rule is disabled. 1: The rule is enabled.
description	String	Rule description.

Status code: 400

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

Status code: 401

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

Status code: 500

**Table 8** 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 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. The URL for the rule is /attack, the content type is sensitive information, and the rule content is ID card number.

PUT https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antileakage/{rule_id}?

{
  "url" : "/login",
  "category" : "sensitive",
  "contents" : [ "id_card" ]
}

Example Responses

Status code: 200

Request sent.

{
  "id" : "82c4f04f84fd4b2b9ba4b4ea0df8ee82",
  "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
  "description" : "demo",
  "status" : 1,
  "url" : "/login",
  "category" : "sensitive",
  "contents" : [ "id_card" ]
}