Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Tenant Collection/ Querying the Collection Parser Template List
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Collection Parser Template List

Function

This API is used to query the list of collection parser templates.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/collector/logstash/parsers/templates

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

Value Range

N/A

Default value

N/A

workspace_id

Yes

String

Workspace ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

title

No

String

Parser title.

description

No

String

Parser description.

offset

No

Long

Page number.

limit

No

Long

Number of records on each page.

sort_key

No

String

Sorting field.

sort_dir

No

String

Definition

Directory sorting.

  • asc: ascending order

  • desc: descending order

Constraints

N/A

Range

  • asc

  • desc

Default Value

N/A

Request Parameters

Table 3 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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Count.

records

Array of ParserTemplate objects

Description.
Table 5 ParserTemplate

Parameter

Type

Description

description

String

Description.

parser_id

String

UUID

title

String

Related title.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic: Tenant Collection