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

Querying Plugin Configuration Template Details

Function

This API is used to query the plugin configuration template details during workflow configuration.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/soc/components/template/{template_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

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Range

N/A

template_id

Yes

String

ID of the plugin configuration template.

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

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

success

Boolean

Request status.

request_id

String

Request ID.

data

TemplateInfo object

Plugin configuration template information.
Table 4 TemplateInfo

Parameter

Type

Description

id

String

Template ID.

component_id

String

Plugin ID.

template_name

String

Name of the plugin configuration template.

task_config

String

Plugin action configuration content.

create_time

String

Creation time.

update_time

String

Update time.

project_id

String

Project ID.

Status code: 400

Table 5 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

Object returned upon a successful response.

400

Object returned upon a response error.

Error Codes

See Error Codes.