Help Center/ Web Application Firewall/ API Reference/ APIs/ Rule Management/ Querying the List of Information Leakage Prevention Rules

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

View PDF

Querying the List of Information Leakage Prevention Rules

Function

This API is used to query the list of information leakage prevention rules.

URI

GET /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	ID of a protection policy. You can specify a protection policy ID to query the information leakage prevention rules used in the protection policy. You can obtain the policy ID 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.
offset	Yes	Integer	Offset. The records after the offset are queried.
limit	Yes	Integer	Maximum number of records that can be returned.

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
total	Integer	The number of information leakage prevention rules
items	Array of LeakageListInfo objects	The list of information leakage prevention rules

**Table 5** LeakageListInfo
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
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.
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 query the information leakage protection rule list in a project. The project ID is specified by project_id, and the policy is specified by policy_id.

GET https://{Endpoint}/v1/{project_id}/waf/policy/{policy_id}/antileakage?offset=0&limit=2

Example Responses

Status code: 200

Request sent.

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