Updated on 2025-10-29 GMT+08:00

Creating Code Snippets

Function

This API is used to create code snippets.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/siem/code-segments

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.

Request Parameters

Table 2 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

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

code_segment_name

Yes

String

Code snippet name.

description

No

String

Code snippet description.

code

Yes

String

Code snippet.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code_segment_id

String

UUID

project_id

String

Project ID.

workspace_id

String

Workspace ID.

code_negment_name

String

Code snippet name.

description

String

Code snippet description.

code

String

Code snippet.

create_by

String

IAM user ID.

create_time

Integer

Timestamp, in ms.

update_by

String

IAM user ID.

update_time

Integer

Timestamp, in ms.

Status code: 400

Table 5 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

Request succeeded.

400

Error response

Error Codes

See Error Codes.