Views:

Last Updated: 1/22/2020 12:11:14 AM

Update notification settings for customers.

Request

HTTP Request

PUT /SMPI/{version}/service/wfbss/api/notif_settings

Parameters

Name

Type

Description

Validation

Required Parameters

cids

string

A list of customer ID separated by comma.

At least one customer ID must be specified, and no more than 10.

Optional Parameters

sync

boolean

Set whether to process the update synchronously.

If not set, the default is false.

HTTP Request Example

1. Synchronously update notification settings for one customer.				
PUT /SMPI/{version}/service/wfbss/api/notif_settings?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C&sync=true				

2. Asynchronously update notification settings for multiple customers at once. The changes will affect all of the sepecified customers.				
PUT /SMPI/{version}/service/wfbss/api/notif_settings?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3

Request Body

1. Disable Web Reputation > URL violations exceed" notification"    
{    
    "notif_setting": {    
        "wtp": {    
            "notify_incident_exceed": false    
        }    
    }    
}    

2. Update the subject and message of of Antivirus > Viruses exceed" notification"    
{    
    "notif_setting": {    
        "antivirus": {    
            "msg": {    
                "1": {    
                    "subject": "[%SUBJECT_PREFACE][Warning] Excessive viruses detected"    
                    "content": "Trend Micro Worry-Free Business Security Services Notification\n\n* Action Unsuccessful:                     %NUMBER\n* Report Time:                             %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/Outbreak Defense for further details on %WEB_CONSOLE_LINK"    
                }    
            }    
        }    
    }    
}    
3. Set subject preface of and recipients of email notification    
{    
    "notif_setting": {    
        "subject_preface": "Example Company",    
        "recipients": [    
            "user1@example.com",    
            "user2@example.com"    
        ]    
    }    
}

Name

Type

Description

Validation

notif_setting.subject_preface

string

Subject preface of email notification

length: 64 characters

notif_setting.recipients

string array

Recipients of email notification

For example, [user1@example.com, user2@example.com]

notif_setting.wtp.msg.0.content

string

Web Reputation > URL violations exceed: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.wtp.msg.0.subject

string

Web Reputation > URL violations exceed: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.wtp.threshold.0.threshold

integer

Web Reputation > URL violations exceed: configure the number of incidents within each time period to trigger an alert

>= 0

notif_setting.wtp.threshold.0.time_interval

integer

Web Reputation > URL violations exceed : configure the time period when a certain numbers of incidents occur within to trigger an

In seconds

notif_setting.wtp.notify_incident_exceed

integer

Web Reputation > URL violations exceed: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.license.msg.0.content

string

License > License expires in less than 60 days: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.license.msg.0.subject

string

License > License expires in less than 60 days: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.license.notify_license_expire_warn

integer

License > License expires in less than 60 days: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.license.msg.1.content

string

License > License expired: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.license.msg.1.subject

string

License > License expired: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.license.notify_license_expired

integer

License > License expired: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.license.msg.2.content

string

License > Seat license usage is greater than 100%: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.license.msg.2.subject

string

License > Seat license usage is greater than 100%: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.license.notify_seat_count_exceed_warn

integer

License > Seat license usage is greater than 100%: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.license.msg.3.content

string

License > Seat license usage is greater than 110%: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.license.msg.3.subject

string

License > Seat license usage is greater than 110%: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.license.notify_seat_count_exceed_crit

integer

License > Seat license usage is greater than 110%: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.update.msg.0.content

string

Component update > Warning > Update deployment rate less than: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.update.msg.0.subject

string

Component update > Warning > Update deployment rate less than: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.update.threshold.0.threshold

integer

Component update > Warning > Update deployment rate less than: configure the lower bound of deployment rate to trigger an alert

>= 0

notif_setting.update.notify_deployment_rate_warn

integer

Component update > Warning > Update deployment rate less than: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.update.msg.1.content

string

Component update > Action Required > Update deployment rate less than: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.update.msg.1.subject

string

Component update > Action Required > Update deployment rate less than: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.update.threshold.1.threshold

integer

Component update > Action Required > Update deployment rate less than: configure the lower bound of deployment rate to trigger an alert

>= 0

notif_setting.update.notify_deployment_rate_crit

integer

Component update > Action Required > Update deployment rate less than: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.smart_scan.msg.0.content

string

Smart Scan > Agents disconnected from Smart Scan Server: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.smart_scan.msg.0.subject

string

Smart Scan > Agents disconnected from Smart Scan Server: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.smart_scan.notify_cloudscan_connect

integer

Smart Scan > Agents disconnected from Smart Scan Server: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.behavior_monitoring.msg.0.content

string

Behavior Monitoring > Behavior Monitoring violations exceed : notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.behavior_monitoring.msg.0.subject

string

Behavior Monitoring > Behavior Monitoring violations exceed : notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.behavior_monitoring.threshold.0.threshold

integer

Behavior Monitoring > Behavior Monitoring violations exceed : configure the number of incidents within each time period to trigger an alert

>= 0

notif_setting.behavior_monitoring.threshold.0.time_interval

integer

Behavior Monitoring > Behavior Monitoring violations exceed: configure the time period when a certain numbers of incidents occur within to trigger an alert

In seconds

notif_setting.behavior_monitoring.notify_incident_exceed

integer

Behavior Monitoring > Behavior Monitoring violations exceed notify when the alert is triggerd

1 = True; 0 = False

notif_setting.url_filtering.msg.0.content

string

URL Filtering > URL violations exceed: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.url_filtering.msg.0.subject

string

URL Filtering > URL violations exceed: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.url_filtering.threshold.0.threshold

integer

URL Filtering > URL violations exceed: configure the number of incidents within each time period to trigger an alert

>= 0

notif_setting.url_filtering.threshold.0.time_interval

integer

URL Filtering > URL violations exceed: configure the time period when a certain numbers of incidents occur within to trigger an alert

In seconds

notif_setting.url_filtering.notify_incident_exceed

integer

URL Filtering > URL violations exceed: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.antispyware.msg.0.content

string

Anti-spyware > Spyware detected - device restart required: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antispyware.msg.0.subject

string

Anti-spyware > Spyware detected - device restart required: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antispyware.notify_need_restart

integer

Anti-spyware > Spyware detected - device restart required: notify when alert is triggerd

1 = True; 0 = False

notif_setting.antispyware.msg.1.content

string

Anti-spyware > Spyware/Grayware incidents exceed: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antispyware.msg.1.subject

string

Anti-spyware > Spyware/Grayware incidents exceed: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antispyware.threshold.0.threshold

integer

Anti-spyware > Spyware/Grayware incidents exceed: configure the number of incidents within each time period to trigger an alert

>= 0

notif_setting.antispyware.threshold.0.time_interval

integer

Anti-spyware > Spyware/Grayware incidents exceed: configure the time period when a certain numbers of incidents occur within to trigger an alert

In seconds

notif_setting.antispyware.notify_incident_exceed

integer

Anti-spyware > Spyware/Grayware incidents exceed: notify when alert is triggerd

1 = True; 0 = False

notif_setting.antivirus.msg.0.content

string

Antivirus > Virus detected - actions unsuccessful: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antivirus.msg.0.subject

string

Antivirus > Virus detected - actions unsuccessful: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antivirus.notify_action_failure

integer

Antivirus > Virus detected - actions unsuccessful: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.antivirus.msg.1.content

string

Antivirus > Viruses exceed: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antivirus.msg.1.subject

string

Antivirus > Viruses exceed: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antivirus.threshold.0.threshold

integer

Antivirus > Viruses exceed: configure the number of incidents within each time period to trigger an alert

>= 0

notif_setting.antivirus.threshold.0.time_interval

integer

Antivirus > Viruses exceed: configure the time period when a certain numbers of incidents occur within to trigger an alert

In seconds

notif_setting.antivirus.notify_incident_exceed

integer

Antivirus > Viruses exceed: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.antivirus.msg.2.content

string

Antivirus > Real-time scan is disabled: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antivirus.msg.2.subject

string

Antivirus > Real-time scan is disabled: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.antivirus.notify_realtime_scan_disabled

integer

Antivirus > Real-time scan is disabled: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.outbreak.msg.0.content

string

Outbreak Defense > Red alert activated: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.outbreak.msg.0.subject

string

Outbreak Defense > Red alert activated: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.outbreak.notify_red_alert

integer

Outbreak Defense > Red alert activated: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.outbreak.msg.1.content

string

Outbreak Defense > Yellow alert activated: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.outbreak.msg.1.subject

string

Outbreak Defense > Yellow alert activated: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.outbreak.notify_yellow_alert

integer

Outbreak Defense > Yellow alert activated: notify when the alert is triggerd

1 = True; 0 = False

notif_setting.network_virus.msg.0.content

string

Network Virus > Network viruses exceed: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.network_virus.msg.0.subject

string

Network Virus > Network viruses exceed: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.network_virus.threshold.0.threshold

integer

Network Virus > Network viruses exceed: configure the number of incidents within each time period to trigger an alert

>= 0

notif_setting.network_virus.threshold.0.time_interval

integer

Network Virus > Network viruses exceed: configure the time period when a certain numbers of incidents occur within to trigger an alert

In seconds

notif_setting.network_virus.notify_incident_exceed

integer

Network Virus > Network viruses exceed: notify when alert is triggerd

1 = True; 0 = False

notif_setting.device_control.msg.0.content

string

Device Control > Device Control violations exceed: notification message

Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.device_control.msg.0.subject

string

Device Control > Device Control violations exceed: notification subject

length: 255 characters. Please refer to Customizing Notification Alerts section in WFBS-SVC Online Help

notif_setting.device_control.notify_incident_exceed

integer

Device Control > Device Control violations exceed notify when the alert is triggered

1 = True; 0 = False

notif_setting.device_control.threshold.0.threshold

integer

Device Control > Device Control violations exceed : configure the number of incidents within each time period to trigger an alert

>= 0

notif_setting.device_control.threshold.0.time_interval

integer

Device Control > Device Control violations exceed: configure the time period when a certain numbers of incidents occur within to trigger an alert

In seconds

Response

Response

If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:

1. If parameter sync is set true, the response body is empty.

2. Otherwise, the reponse body is as below:
{
    "task": {
        "status": "PENDING",
        "id": "0e41dc95-eb78-4dd3-9c1f-3bc47b915ab4"
    }
}

Name

Type

Description

Length

task.id

string

The ID of the asynchronous task to update global settings.

GUID

task.status

string

The status of the asynchronous task to update global settings.

PENDING, STARTED, SUCCESS, FAILURE, or REVOKED
Parent topic: Notification Settings