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

Importing a Collection Parser

Function

This API is used to import a collection parser.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/collector/logstash/parsers/import

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 FormData parameters

Parameter

Mandatory

Type

Description

files

Yes

File

Array of imported files.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

success

Integer

Number of successes.

fail

Integer

Number of failed records.

result

Array of ImportParserVo objects

Parser array.
Table 5 ImportParserVo

Parameter

Type

Description

parser_title

String

Parser name.

file_name

String

Parser file name.

success

Boolean

Whether the import is successful.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success

Error Codes

See Error Codes.

Parent topic: Tenant Collection