Help Center> Web Application Firewall> API Reference> APIs> Rule Management> Creating an Information Leakage Prevention Rule
Updated on 2024-04-25 GMT+08:00

Creating an Information Leakage Prevention Rule

Function

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

URI

POST /v1/{project_id}/waf/policy/{policy_id}/antileakage

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.

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

Rule content. The value can be HTTP status code: 400, 401, 402, 403, 404, 405, 500, 501, 502, 503, 504, 507; 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

Content

timestamp

Long

Timestamp the rule is created.

status

Integer

Rule status. The value can be 0 or 1.

  • 0: The rule is disabled.

  • 1: The rule is enabled.

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 create an information leakage protection rule in a project. The project ID is specified by project_id, and the policy is specified by policy_id. The URL for the rule is /attack, the content type is sensitive information, and the rule content is ID card number.

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

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

Example Responses

Status code: 200

Request sent.

{
  "id" : "82c4f04f84fd4b2b9ba4b4ea0df8ee82",
  "policyid" : "2fcbcb23ef0d48d99d24d7dcff00307d",
  "timestamp" : 1668152426471,
  "status" : 1,
  "url" : "/attack",
  "category" : "sensitive",
  "contents" : [ "id_card" ]
}

Status Codes

Status Code

Description

200

Request sent.

400

Request failed.

401

The token does not have required permissions.

500

Internal server error.

Error Codes

See Error Codes.