Help Center/ SecMaster/ API Reference (Kuala Lumpur Region)/ API/ Playbook Review Management/ Reviewing a Playbook
Updated on 2025-07-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Reviewing a Playbook

Function

This API is used to review a playbook.

Calling Method

For details, see Calling APIs.

URI

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

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

workspace_id

Yes

String

Workspace ID.

version_id

Yes

String

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 the user token.

content-type

Yes

String

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

Parameter

Mandatory

Type

Description

result

No

String

PASS or UN_PASS

content

No

String

Review comments.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 5 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Response message.

data

ApproveOpinionDetail object

Review details.
Table 6 ApproveOpinionDetail

Parameter

Type

Description

result

String

Review result.

content

String

Review content.

Status code: 400

Table 7 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 8 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error description.

Example Requests

Review a playbook. The review result is "PASS" and the review comments are "xxxxx."

{
  "result" : "PASS",
  "content" : "xxxxx"
}

Example Responses

Status code: 200

Response to a successful request.

{
  "code" : 0,
  "message" : "Error message",
  "data" : {
    "result" : "PASS",
    "content" : "need modify"
  }
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

Response message for failed requests.

Error Codes

See Error Codes.