Help Center/ Web Application Firewall/ API Reference/ APIs/ Alarm Management/ This API is used to update alarm notification configuration.

Updated on 2024-04-25 GMT+08:00

View PDF

This API is used to update alarm notification configuration.

Function

Updating Alarm Notification Configuration

URI

PUT /v2/{project_id}/waf/alert/{alert_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID
alert_id	Yes	String	Alarm ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Tenant token.
Content-Type	Yes	String	Content type. Default: application/json;charset=utf8
X-Language	Yes	String	zh-cn/en-us

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Alarm notification name
enabled	No	Boolean	Whether to enable this function. false: It is disabled for WAF. true: It is enabled.
topic_urn	Yes	String	Topic URN. You can obtain it by calling an API of [Simple Message Notification].
sendfreq	No	Integer	Interval, in minute. When the notification type is event, an alarm notification is sent when the number of attacks within the given interval is greater than or equal to the threshold. The value can be 5, 15, 30, 60, 120, 360, 720, or 1440. When the notification type is certificate expiration, an alarm notification is sent once within the give interval. The supported values are 1440 and 10080 (unit: minute). Default: 5
locale	No	String	Language. zh-cn: Chinese. en-us: English.
times	No	Integer	This parameter is mandatory when notification type is event-based. A notification alarm is sent when the number of attacks reaches the configured threshold. Default: 1
threat	No	Array of strings	Event type
notice_class	Yes	String	Notification type. threat_alert_notice: Events. cert_alert_notice: Certificate expiration
nearly_expired_time	No	String	How long before you certificate expires you want the system to notify you. This parameter is mandatory when the notification type is certificate expiration.
is_all_enterprise_project	No	Boolean	Whether all enterprise projects are involved.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
id	String	ID
name	String	Alarm notification name
enabled	Boolean	Whether to enable this function false: It is disabled for WAF. true: Enable
topic_urn	String	Theme
sendfreq	Integer	Interval, in minute. When the notification type is event, an alarm notification is sent when the number of attacks within the given interval is greater than or equal to the threshold. The value can be 5, 15, 30, 60, 120, 360, 720, or 1440. When the notification type is certificate expiration, an alarm notification is sent once within the give interval. The supported values are 1440 and 10080 (unit: minute).
locale	String	Languages
times	Integer	This parameter is mandatory when notification type is event-based. A notification alarm is sent when the number of attacks reaches the configured threshold. Default: 1
threat	Array of strings	Event type.
prefer_html	Boolean	This parameter is reserved and can be ignored. Default: false
notice_class	String	Alarm type.
nearly_expired_time	String	Advance notification days
is_all_enterprise_project	Boolean	Whether all enterprise projects are involved. Default: true
enterprise_project_id	String	Enterprise project ID.
update_time	Long	Update time.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 401

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Status code: 500

**Table 7** Response body parameters
Parameter	Type	Description
error_code	String	Error code
error_msg	String	Error message

Example Requests

The following example shows how to update the alarm notification configuration for a project. Project ID: project_id. Notification type: Certificate expiration. Topic URN: urn:smn:xx-xxxxx-x:550500b49078408682d0d4f7d923f3e1:ces_zyh_test. Alarm notification name: test. Notifications are sent 60 days before a certificate expires at an interval of 10,080 minutes.

PUT https://{Endpoint}/v2/{project_id}/waf/alert/{alert_id}?enterprise_project_id=0

{
  "notice_class" : "cert_alert_notice",
  "topic_urn" : "urn:smn:xx-xxxxx-x:550500b49078408682d0d4f7d923f3e1:ces_zyh_test",
  "name" : "test",
  "nearly_expired_time" : 60,
  "sendfreq" : 10080
}

Example Responses

Status code: 200

Request succeeded.

{
  "enabled" : true,
  "enterprise_project_id" : "0",
  "id" : "7a19ee86a7dc43f0b12093decb795096",
  "is_all_enterprise_project" : true,
  "locale" : "zh-cn",
  "name" : "demo",
  "nearly_expired_time" : 60,
  "notice_class" : "cert_alert_notice",
  "prefer_html" : false,
  "sendfreq" : 10080,
  "threat" : [ ],
  "times" : 1,
  "topic_urn" : "urn:smn:xx-xxxxx-x:550500b49078408682d0d4f7d923f3e1:ces_zyh_test"
}