Help Center/ Data Security Center/ API Reference/ API Description/ Obtaining the Basic Rule Information List/ Obtaining the Basic Rule Information List
Updated on 2026-01-13 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Obtaining the Basic Rule Information List

Function

This API is used to obtain the basic rule information list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/scan-rules

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID, which is used to identify a specific project.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

scan_rules_list

Array of ShowScanRuleBasicInfo objects

Rule list, which contains the details of each rule.

total

Long

Total number of rules.
Table 3 ShowScanRuleBasicInfo

Parameter

Type

Description

category

String

Rule category, which is used to identify BUILT_IN (built-in rules) and BUILT_SELF (user-defined rules).

project_id

String

Project ID, which is used to identify a specific project.

rule_desc

String

Rule description, which briefly describes the rule function.

rule_id

String

Rule ID, which uniquely identifies a rule.

rule_name

String

Rule name, which is used to identify and manage rules.

rule_type

String

Rule type, which can be KEYWORD (keyword), REGEX (regular expression), or NLP (natural language).

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Request succeeded. The scan rule details are returned.

401

Unauthorized. The user is not logged in or the token is invalid.

403

Unauthorized to access the resource.

404

The specified rule is not found.

Error Codes

See Error Codes.