Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Alert Management/ Importing Alerts
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Importing Alerts

Function

This API is used to batch import alerts. You need to fill in the downloaded template based on the data object types and descriptions specified for security incidents. Mandatory fields cannot be left empty. The backend will verify all fields during import.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/alerts/import

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

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

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 3 FormData parameters

Parameter

Mandatory

Type

Description

uploadFile

Yes

File

File of the alerts to be imported.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

code

String

Error code.

message

String

Error message.

data

data object

Returned data of alert import results.
Table 5 data

Parameter

Type

Description

ids

Array of strings

IDs of the imported alerts.

Status code: 400

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

Response body of requests for importing alerts.

400

Response body for failed requests for importing alerts.

Error Codes

See Error Codes.

Parent topic: Alert Management