Help Center/ SecMaster/ API Reference/ SecMaster APIs (V2)/ Alert Rule Management/ Enabling an Alert Rule
Updated on 2026-02-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Enabling an Alert Rule

Function

This API is used to enable an alert rule.

Calling Method

For details, see Calling APIs.

URI

POST /v2/{project_id}/workspaces/{workspace_id}/siem/alert-rules/{alert_rule_id}/enable

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.

alert_rule_id

Yes

String

Alert rule 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

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

alert_rule_id

String

UUID

status

String

Definition

Job status.

  • ENABLED

  • DISABLED

Constraints

N/A

Range

  • ENABLED

  • DISABLED

Default Value

N/A

process_status

String

Definition

Job processing status.

  • COMPLETED: completed.

  • CREATING: being created

  • UPDATING: being updated

  • ENABLING: being enabled

  • DISABLING: being disabled

  • DELETING: being deleted

  • CREATE_FAILED: creation failed

  • UPDATE_FAILED: update failed

  • ENABLE_FAILED: enabling failed

  • DISABLE_FAILED: disabling failed

  • DELETE_FAILED: deletion failed

  • RECOVERING: being recovered

Constraints

N/A

Range

  • COMPLETED

  • CREATING

  • UPDATING

  • ENABLING

  • DISABLING

  • DELETING

  • CREATE_FAILED

  • UPDATE_FAILED

  • ENABLE_FAILED

  • DISABLE_FAILED

  • DELETE_FAILED

  • RECOVERING

Default Value

N/A

Example Requests

{ }

Example Responses

Status code: 200

Request succeeded.

{ }

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Alert Rule Management