Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Directory Customization/ Querying the List of Directories by Condition
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the List of Directories by Condition

Function

This API is used to query the list of directories based on specified conditions.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/catalogues/search

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.

Constraints

N/A

Range

N/A

Default Value

N/A
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

Integer

Definition

Data volume.

Constraints

N/A

Range

N/A

Default Value

N/A

offset

No

Integer

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 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
Table 4 Request body parameters

Parameter

Mandatory

Type

Description

parent_catalogue

No

String

Level-1 directory name.

second_catalogue

No

String

Level-2 directory name.

catalogue_status

No

Boolean

Built-in or not.

layout_name

No

String

Layout name.

publisher_name

No

String

Publisher.

analysis_version

No

String

Security analysis version.

Response Parameters

Status code: 200

Table 5 Response header parameters

Parameter

Type

Description

X-request-id

String

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

Parameter

Type

Description

code

String

Error code.

data

Array of CatalogueDetailInfo objects

Data list.

message

String

Error message

request_id

String

Request id

success

Boolean

Whether the response is successful.

total

Integer

tatal count
Table 7 CatalogueDetailInfo

Parameter

Type

Description

id

String

Directory ID.

parent_catalogue

String

Level-1 directory name.

second_catalogue

String

Level-2 directory name.

catalogue_status

Boolean

Whether the directory is built in the system.

catalogue_address

String

Directory address.

layout_id

String

layout id.

layout_name

String

Layout name.

publisher_name

String

Publisher.

is_card_area

Boolean

Whether to display the card area.

is_display

Boolean

Whether to display the directory.

is_landing_page

Boolean

Whether the page is a landing page.

is_navigation

Boolean

Whether to display the breadcrumb navigation.

parent_alias_en

String

Level-1 directory alias (English).

parent_alias_zh

String

Level-1 directory alias (Chinese).

second_alias_en

String

Level-2 directory alias (English).

second_alias_zh

String

Level-2 directory alias (Chinese).

Status code: 400

Table 8 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 9 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

Request succeeded.

400

Request failed.

Error Codes

See Error Codes.

Parent topic: Directory Customization