Help Center/ SecMaster/ API Reference/ API/ Playbook Action Management/ Creating a Playbook Action
Updated on 2025-03-20 GMT+08:00
View PDF

Creating a Playbook Action

Function

Creating a Playbook Action

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/playbooks/versions/{version_id}/actions

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID

version_id

Yes

String

Playbook version ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

content-type

Yes

String

application/json;charset=UTF-8
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

[items]

Yes

Array of CreateAction objects

Create actions
Table 4 CreateAction

Parameter

Mandatory

Type

Description

name

No

String

Name.

description

No

String

Description.

action_type

Yes

String

Type. The default value is AOP_WORKFLOW.

action_id

Yes

String

Playbook workflow ID.

sort_order

No

String

Sort By

Response Parameters

Status code: 200

Table 5 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.
Table 6 Response body parameters

Parameter

Type

Description

code

String

Error code

message

String

Error message

data

Array of ActionInfo objects

list of informations of playbook action
Table 7 ActionInfo

Parameter

Type

Description

id

String

Playbook workflow ID.

name

String

Workflow name.

description

String

Description.

action_type

String

Workflow type.

action_id

String

Workflow ID.

playbook_id

String

Playbook ID.

playbook_version_id

String

Playbook version ID.

project_id

String

Project ID.

Status code: 400

Table 8 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID, in the format request_uuid-timestamp-hostname.
Table 9 Response body parameters

Parameter

Type

Description

code

String

Error Code

message

String

Error Description

Example Requests

Create a playbook workflow. Workflow name is MyXXX; Description is This my XXXX; Workflow type is aopworkflow; Workflow ID is 909494e3-558e-46b6-a9eb-07a8e18ca62f; Sorted by string.

[ {
  "name" : "MyXXX",
  "description" : "This my XXXX",
  "action_type" : "aopworkflow",
  "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "sort_order" : "string"
} ]

Example Responses

Status code: 200

Response when the request is successful.

{
  "code" : 0,
  "message" : "Error message",
  "data" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "MyXXX",
    "description" : "This my XXXX",
    "action_type" : "Workflow",
    "action_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "playbook_id" : "string",
    "playbook_version_id" : "string",
    "project_id" : "string"
  } ]
}

Status Codes

Status Code

Description

200

Response when the request is successful.

400

Response when the request failed.

Error Codes

See Error Codes.

Parent Topic: Playbook Action Management