Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Tenant Collection/ Creating a Collection Channel
Updated on 2025-12-18 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

Value 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

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

description

No

String

Description.

group_id

Yes

String

UUID

input

Yes

Array of CreateModuleVo objects

Description.

nodes

Yes

Array of NodeVo objects

Description.

output

Yes

Array of CreateModuleVo objects

Description.

parser_id

Yes

String

UUID

title

Yes

String

Related title.
Table 4 NodeVo

Parameter

Mandatory

Type

Description

args

No

Array of ArgsVo objects

Description.

node_id

No

String

UUID

node_status

No

String

Definition

Node status.

  • RUN: running

  • STOP: stopped

Constraints

N/A

Range

  • RUN

  • STOP

Default Value

N/A
Table 5 ArgsVo

Parameter

Mandatory

Type

Description

key

No

String

Key.

value

No

String

Value.
Table 6 CreateModuleVo

Parameter

Mandatory

Type

Description

children

No

Array of CreateModuleVo objects

Description.

connection_module_id

No

String

UUID

fields

No

Array of ModuleFieldVo objects

Description.

name

No

String

Name.

template_id

No

String

UUID
Table 7 ModuleFieldVo

Parameter

Mandatory

Type

Description

connection_module_id

No

String

UUID

name

No

String

Name.

other

No

String

Other information.

template_field_id

No

String

UUID

type

No

String

Type.

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

Successful.

Error Codes

See Error Codes.

Parent topic: Tenant Collection