Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Tenant Collection/ Exporting a Collection Parser

Updated on 2025-10-29 GMT+08:00

Online Debugging

CLI Examples

View PDF

Exporting a Collection Parser

Function

This API is used to export a collection parser.

Calling Method

For details, see Calling APIs.

URI

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

**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
parser_ids	Yes	Array of strings	Description.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
parser_ids	Array of ExportParserResponseDto objects	Description.

**Table 5** ExportParserResponseDto
Parameter	Type	Description
title	String	Related title.
description	String	Description.
modules	Array of ShowModuleExportVo objects	Description.

**Table 6** ShowModuleExportVo
Parameter	Type	Description
module_id	String	UUID
template_id	String	UUID
name	String	Tenant name.
fields	Array of ShowModuleFieldExportVo objects	Description.
children	Array of ShowModuleExportVo objects	Description.

**Table 7** ShowModuleFieldExportVo
Parameter	Type	Description
template_field_id	String	UUID
name	String	Tenant name.
type	String	Type.
value	String	Value.

Example Requests

None

Example Responses

None

Status Codes

Status Code	Description
200	Success

Error Codes

See Error Codes.

Parent topic: Tenant Collection

Previous topic: Deleting a Collection Parser

Next topic: Importing a Collection Parser

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.