Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Tenant Collection/ Querying the Parser Rule List
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Parser Rule List

Function

This API is used to query the list of parser rules.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/collector/module-templates/restriction

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

template_ids

Yes

Array of strings

Description.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array of ShowTemplateFields objects

Template description information array.
Table 5 ShowTemplateFields

Parameter

Type

Description

template_id

String

UUID

fields

Array of TemplateField objects

Description.
Table 6 TemplateField

Parameter

Type

Description

template_field_id

String

UUID

title

String

Related title.

type

String

Rule type.

name

String

Rule name.

description

String

Description.

default_value

String

Default Value

example

String

Example.

required

Boolean

Mandatory or not.

restrictions

Array of Restriction objects

Description.
Table 7 Restriction

Parameter

Type

Description

title

String

Related title.

type

String

Rule type.

value

String

Rule name.

logic

Boolean

Logical condition.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success

Error Codes

See Error Codes.

Parent topic: Tenant Collection