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

Querying the Collection Connection List

Function

This API is used to query the list of collection connections.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/collector/connections

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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

connection_type

No

String

Definition

Connection type.

  • FILTER: filtering

  • INPUT: input

  • OUTPUT: output

Constraints

N/A

Range

  • FILTER

  • INPUT

  • OUTPUT

Default Value

N/A

title

No

String

Title.

description

No

String

Description.

offset

No

Integer

Offset

limit

No

Integer

Limit

sort_key

No

String

Sort Key

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 Connection objects

Description.
Table 5 Connection

Parameter

Type

Description

connection_id

String

UUID

module_id

String

UUID

template_title

String

Related title.

title

String

Related title.

channel_refer_count

Integer

Numerical value.

info

String

Description.

description

String

Description.

connection_type

String

Definition

Connection type.

  • FILTER: filtering

  • INPUT: input

  • OUTPUT: output

Constraints

N/A

Range

  • FILTER

  • INPUT

  • OUTPUT

Default Value

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Success

Error Codes

See Error Codes.

Parent topic: Tenant Collection