Help Center/ SecMaster/ API Reference/ Security Analysis V2 APIs/ Directory Management/ Querying the Directory Group
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Directory Group

Function

This API is used to query the directory group.

Calling Method

For details, see Calling APIs.

URI

GET /v2/{project_id}/workspaces/{workspace_id}/siem/directories

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

Workspace ID.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

category

Yes

String

Definition

Directory type.

  • TABLE: table

  • PIPE: pipeline

  • RETRIEVE_SCRIPT: retrieval script

  • ANALYSIS_SCRIPT: analysis script

  • DATA_TRANSFORMATION: data processing

  • ALERT_RULE: alert rule

Constraints

N/A

Range

  • TABLE

  • PIPE

  • RETRIEVE_SCRIPT

  • ANALYSIS_SCRIPT

  • DATA_TRANSFORMATION

  • ALERT_RULE

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

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

project_id

String

Project ID.

workspace_id

String

Workspace ID.

directories

Array of strings

List of directories.

directory_i18ns

Array of DirectoryI18N objects

Directory I18N list.
Table 5 DirectoryI18N

Parameter

Type

Description

directory

String

Directory group.

directory_en

String

Directory group.

directory_fr

String

Directory group.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response of list directories

400

Error response

Error Codes

See Error Codes.

Parent topic: Directory Management