On this page

Function
Calling Method
URI
Request Parameters
Response Parameters
Example Requests
Example Responses
Status Codes
Error Codes

Show all

Help Center/ SecMaster/ API Reference/ API/ Playbook Management/ Querying the Playbook List

Querying the Playbook List

Updated on 2024-12-25 GMT+08:00

View PDF

Function

Calling Method

For details, see Calling APIs.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.
workspace_id	Yes	String	Workspace ID

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
search_txt	No	String	Keyword
enabled	No	Boolean	Whether to enable.
offset	Yes	Integer	Indicates the page number. Start position of the query result. The value starts from 0.
limit	Yes	Integer	The maximum number of records can be returned on each page for a pagination query. The value starts from 1.
description	No	String	Playbook description.
dataclass_name	No	String	Data class name.
name	No	String	Playbook name.

Request Parameters

**Table 3** 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

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 5** Response body parameters
Parameter	Type	Description
code	String	Error code
message	String	Response message information
total	Integer	Total records.
size	Integer	Records on each page.
page	Integer	Current page.
data	Array of PlaybookInfo objects	Playbook list information.

**Table 6** PlaybookInfo
Parameter	Type	Description
id	String	Playbook ID.
name	String	Playbook name.
description	String	Provides supplementary information about the resource.
create_time	String	Playbook creation time.
update_time	String	Playbook update time.
project_id	String	Project ID.
version_id	String	Playbook version ID.
enabled	Boolean	Whether to enable.
workspace_id	String	Workspace ID
approve_role	String	Reviewer role.
user_role	String	Role
edit_role	String	Edit Role for Account
owner_id	String	ID
version	String	Version No.
dataclass_name	String	Data class name.
dataclass_id	String	Data class ID.
unaudited_version_id	String	ID of the playbook version to be reviewed.
reject_version_id	String	ID of the rejected playbook version.

Status code: 400

**Table 7** Response header parameters
Parameter	Type	Description
X-request-id	String	Request ID, in the format request_uuid-timestamp-hostname.

**Table 8** Response body parameters
Parameter	Type	Description
code	String	Error Code
message	String	Error Description

Example Requests

None

Example Responses

Status code: 200

Response parameters for successful playbook list query.

{
  "code" : 0,
  "message" : null,
  "total" : 41,
  "page" : 10,
  "data" : [ {
    "id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "name" : "MyXXX",
    "description" : "This my XXXX",
    "create_time" : "2021-01-30T23:00:00Z+0800",
    "update_time" : "2021-01-30T23:00:00Z+0800",
    "project_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "enabled" : true,
    "workspace_id" : "string",
    "approve_role" : "approve",
    "user_role" : "string",
    "edit_role" : "editor",
    "owner_id" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
    "version" : "v1.1.1",
    "dataclass_name" : "string",
    "dataclass_id" : "string",
    "unaudited_version_id" : "string",
    "reject_version_id" : "string"
  } ]
}