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

Querying the Plug-in Definition List

Function

This API is used to query the plug-in definition list.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/components

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

Definition

Workspace ID.

Range

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

N/A

limit

No

Integer

Definition

Data volume.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Definition

Response code.

Constraints

N/A

total

Integer

Definition

Total data records.

Constraints

N/A

offset

Integer

Definition

Current page size.

Constraints

N/A

limit

Integer

Definition

Current page number.

Constraints

N/A

message

String

Definition

Error message in the response.

Constraints

N/A

data

Array of ComponentInfo objects

List.
Table 4 ComponentInfo

Parameter

Type

Description

id

String

id

name

String

name

dev_language

String

dev_language

dev_language_version

String

dev_language_version

alliance_id

String

alliance_id

alliance_name

String

alliance_name

description

String

description

logo

String

The market head icon

label

String

The label

create_time

String

create_time

update_time

String

update_time

creator_name

String

Creator name.

operate_history

Array of operate_history objects

Plugin operation history.

versions

Array of ComponentVersionInfo objects

Plugin version information, which is compatible with the previous Java plugin version.

component_type

String

Plugin type. subscribe: subscribed. custom: custom. system: built-in.
Table 5 operate_history

Parameter

Type

Description

operate_name

String

Operation.

operate_time

String

Time.
Table 6 ComponentVersionInfo

Parameter

Type

Description

id

String

id

version_num

String

Version number.

version_desc

String

Version description.

status

String

Status.

package_name

String

Package to which the plugin belongs.

component_attachment_id

String

Attachment ID of the plugin.

sub_version_id

String

Subscription version ID.

connection_config

String

Operation connection configuration list.

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response

400

Error response

Error Codes

See Error Codes.

Parent topic: Plug-in Management