Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Tenant Collection/ Querying Collection Connection Details
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Collection Connection Details

Function

This API is used to query collection connection details.

Calling Method

For details, see Calling APIs.

URI

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

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.

connection_id

Yes

String

Connection 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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

connection_id

String

UUID

description

String

Description.

fields

Array of ConnectionModuleFieldShowVo objects

Description.

module_id

String

UUID

name

String

Tenant name.

template_id

String

UUID

title

String

Related title.
Table 4 ConnectionModuleFieldShowVo

Parameter

Type

Description

field_id

String

UUID

name

String

Tenant name.

template_field_id

String

UUID

type

String

Data type of value.

value

String

Related value.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic: Tenant Collection