Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Data Delivery/ Querying Parameters
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Parameters

Function

This API is used to query parameters.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/siem/shippers/params/{param_type}

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

Value Range

N/A

Default value

N/A

workspace_id

Yes

String

Workspace ID.

param_type

Yes

String

Parameter type.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

param

No

String

The value is determined by param. The value is the ID of the level-1 menu of the type, for example, lts_group_id is a string of IDs.

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

code

Integer

Error code. The value 0 indicates a success. Other values indicate an error.

msg

String

Returned status information, which describes the result of the current request.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Response succeeded.

400

Error response.

Error Codes

See Error Codes.

Parent topic: Data Delivery