Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Playbook Packaging Management/ Importing Playbooks
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Importing Playbooks

Function

This API is used to import playbooks.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/import

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.
Table 3 FormData parameters

Parameter

Mandatory

Type

Description

uploadFile

Yes

File

upload_file

upload_model

No

String

Playbook file upload mode.

import: Importing playbooks

verify: Verifying playbook upload

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Response message.

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

Status code: 200

Response of import playbook

Status Codes

Status Code

Description

200

Response of import playbook

400

Error response

Error Codes

See Error Codes.