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

Creating a Collection Channel

Function

This API is used to create a collection channel.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/collector/channels

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

title

Yes

String

Related title.

description

No

String

Description.

parser_id

Yes

String

UUID

group_id

Yes

String

UUID

input

Yes

Array of CreateModuleVo objects

Description.

output

Yes

Array of CreateModuleVo objects

Description.

nodes

Yes

Array of NodeVo objects

Description.

action

No

String

Definition

Node running status monitoring.

  • START: started

  • STOP: stopped

  • REMOVE: removed

  • RESTART: restarted

  • REFRESH: refreshed

  • INSTALL: being installed

Constraints

N/A

Range

  • START

  • STOP

  • REMOVE

  • RESTART

  • REFRESH

  • INSTALL

Default Value

N/A
Table 4 CreateModuleVo

Parameter

Mandatory

Type

Description

name

No

String

Name.

template_id

No

String

UUID

connection_module_id

No

String

UUID

fields

No

Array of ModuleFieldVo objects

Description.

children

No

Array of CreateModuleVo objects

Description.
Table 5 ModuleFieldVo

Parameter

Mandatory

Type

Description

template_field_id

No

String

UUID

name

No

String

Name.

type

No

String

Type.

value

No

String

Value.

other

No

String

Other information.

connection_module_id

No

String

UUID
Table 6 NodeVo

Parameter

Mandatory

Type

Description

node_id

No

String

UUID

args

No

Array of ArgsVo objects

Description.

node_status

No

String

Definition

Node status.

  • RUN: running

  • STOP: stopped

Constraints

N/A

Range

  • RUN

  • STOP

Default Value

N/A
Table 7 ArgsVo

Parameter

Mandatory

Type

Description

key

No

String

key

value

No

String

value

Response Parameters

Status code: 200

Table 8 Response body parameters

Parameter

Type

Description

success

Boolean

Created successfully.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success

Error Codes

See Error Codes.

Parent topic: Tenant Collection