Last Updated: 1/22/2020 12:11:34 AM
Get notification settings for customers
Request
HTTP Request
GET /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 |
|||
fields |
string |
A list of notification settings separated by comma. If set, only the specified notification settings will be returned. Otherwise, all notification settings will be returned. |
Valid values: outbreak, antivirus, antispyware, wtp, url_filtering, behavior_monitoring, device_control, network_virus, smart_scan, update, license, subject_preface, recipients |
HTTP Request Example
Get all notification settings:
GET /SMPI/{version}/service/wfbss/api/notif_settings?cids=74AE704D-CD9E-4F45-A62B-CA3AED65F99F
Get specified notification settings:
GET /SMPI/{version}/service/wfbss/api/notif_settings?cids=74AE704D-CD9E-4F45-A62B-CA3AED65F99F&fields=outbreak,antivirus
Request Body
Do not supply a request body with this method.
Response
Response
If successful, this method returns an HTTP 200 OK status code and a response body with the following structure:
{
"customers": [
{
"eid": "AF83C6B6-BD43-4CB7-9B8D-296A7D51E865",
"id": "AEE6F73D-6AFC-44CC-8C44-AC54A7A1E163",
"notif_setting": {
"antispyware": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\n* Antispyware - Detections requiring device restart: %NUMBER\n* Report time: %DATE_TIME\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK\n* Suggestion:\n Restart the devices to try again.",
"subject": "[%SUBJECT_PREFACE][Action Required] Antispyware - Detections requiring device restart: %NUMBER"
},
"1": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Detections: %NUMBER\n* Spyware/Grayware found: %COUNT\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] Spyware/Grayware detections exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"notify_need_restart": 1,
"threshold": {
"0": {
"threshold": 15,
"time_interval": 3600
}
}
},
"antivirus": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\n* Antivirus - Threats unresolved: %NUMBER\n* Report time: %DATE_TIME\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK\n* Suggestion:\n Run an Aggressive Scan to fix unresolved security risks. If the issue persists after the scan, contact Trend Micro.",
"subject": "[%SUBJECT_PREFACE][Action Required] Antivirus - Threats unresolved: %NUMBER"
},
"1": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Detections: %NUMBER\n* Virus/Malware found: %COUNT\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] Virus detections exceed %THRESHOLD from %FROM to %TO"
},
"2": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\n* Antivirus - Real-time Scan disabled: %NUMBER\n* Report time: %DATE_TIME\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK\n* Suggestion:\n Enable Real-time Scan on all devices on your network to stay protected.",
"subject": "[%SUBJECT_PREFACE][Action Required] Antivirus - Real-time Scan disabled: %NUMBER"
}
},
"notify_action_failure": 0,
"notify_incident_exceed": 0,
"notify_realtime_scan_disabled": 0,
"threshold": {
"0": {
"threshold": 5,
"time_interval": 3600
}
}
},
"application_control": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Violations: %NUMBER\n* Programs blocked: %COUNT\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] Application Control violations exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"threshold": {
"0": {
"threshold": 1,
"time_interval": 3600
}
}
},
"behavior_monitoring": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Violations: %NUMBER\n* Process Terminated/Blocked: %COUNT\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] Behavior Monitoring violations exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"threshold": {
"0": {
"threshold": 20,
"time_interval": 3600
}
}
},
"device_control": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Violations: %NUMBER\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] Device Control violations exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"threshold": {
"0": {
"threshold": 20,
"time_interval": 3600
}
}
},
"dlp": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Violations: %NUMBER\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] Data Loss Prevention violations exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"threshold": {
"0": {
"threshold": 20,
"time_interval": 3600
}
}
},
"license": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nYour license will expire on %DATE.\n* Suggestion: Contact your vendor for purchase details, or check your license information on %LICENSE_LINK",
"subject": "[%SUBJECT_PREFACE][Action Required] Your license will expire on %DATE"
},
"1": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nYour license has expired on %DATE.\n* Suggestion:\n Contact your vendor for purchase details, or check your license information on %LICENSE_LINK",
"subject": "[%SUBJECT_PREFACE][Action Required] Your license has expired on %DATE"
},
"2": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nYour seat usage is more than %THRESHOLD%.\nDesktop/Server seats available: %COMPUTER_PURCHASED_SEAT_COUNT\nMobile device seats available: %MOBILE_SEAT_COUNT\nDesktop/Server seats in use: %COMPUTER_USED_SEAT_COUNT\nMobile device seats in use: %MOBILE_USED_SEAT_COUNT\n\n* Suggestion:\n Contact your vendor for purchase details, or check your license information on %LICENSE_LINK",
"subject": "[%SUBJECT_PREFACE][Action Required] Your seat usage is more than %THRESHOLD%"
},
"3": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nYour seat usage is more than %THRESHOLD%.\nDesktop/Server seats available: %COMPUTER_PURCHASED_SEAT_COUNT\nMobile device seats available: %MOBILE_SEAT_COUNT\nDesktop/Server seats in use: %COMPUTER_USED_SEAT_COUNT\nMobile device seats in use: %MOBILE_USED_SEAT_COUNT\n\n* Suggestion:\n Contact your vendor for purchase details, or check your license information on %LICENSE_LINK",
"subject": "[%SUBJECT_PREFACE][Action Required] Your seat usage is more than %THRESHOLD%"
}
},
"notify_license_expire_warn": 1,
"notify_license_expired": 1,
"notify_seat_count_exceed_crit": 1,
"notify_seat_count_exceed_warn": 1,
"threshold": {
"0": {
"threshold": 100,
"time_interval": 3600
},
"1": {
"threshold": 110,
"time_interval": 3600
}
}
},
"machine_learning": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Detections: %NUMBER\n* Unknown threats found: %COUNT\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] Unknown threat detections exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"threshold": {
"0": {
"threshold": 5,
"time_interval": 3600
}
}
},
"network_virus": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Detections: %NUMBER\n* Network virus found: %COUNT\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] Network virus detections exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"threshold": {
"0": {
"threshold": 10,
"time_interval": 3600
}
}
},
"outbreak": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services \u901a\u77e5\n\u901a\u77e5\n* \u5b89\u5168\u5a01\u8105\u540d\u7a31\uff1a %THREAT_NAME\n\n* \u5b89\u5168\u5a01\u8105\u8aaa\u660e\uff1a\n%THREAT_DESCRIPTION\n\n* \u5df2\u95dc\u9589\u75ab\u60c5\u7206\u767c\u9632\u7bc4\u529f\u80fd\u7684\u88dd\u7f6e\uff1a\n- %DEVICE_LIST\n\n\u5982\u9700\u8a73\u7d30\u8cc7\u8a0a\uff0c\u8acb\u53c3\u95b1 %WEB_CONSOLE_LINK \u4e0a\u7684\u300c\u5373\u6642\u72c0\u614b/\u75ab\u60c5\u7206\u767c\u9632\u7bc4\u300d",
"subject": "[%SUBJECT_PREFACE][Warning] Red alert - %THREAT_NAME"
},
"1": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\n* Threat Name: %THREAT_NAME\n\n* Threat Description:\n%THREAT_DESCRIPTION\n\n* Outbreak Prevention Disabled Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/Outbreak Defense for further details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE][Warning] Yellow alert - %THREAT_NAME"
}
},
"notify_red_alert": 1,
"notify_yellow_alert": 1
},
"recipients": [
"chunhua_chen@trend.com.tw"
],
"smart_scan": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\n* Smart Scan Server - Agents disconnected: %NUMBER\n* Report time: %DATE_TIME\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK\n* Suggestion:\n Check the Agent's Internet connection.",
"subject": "[%SUBJECT_PREFACE][Action Required] Smart Scan Server - Agents disconnected: %NUMBER"
}
},
"notify_cloudscan_connect": 1
},
"subject_preface": "Chunhua Chen",
"update": {
"msg": {
"0": {
"content": "update.deployment_rate_warn.content",
"subject": "update.deployment_rate_warn.subject"
},
"1": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\n* Update deployment rate less than %THRESHOLD% after two hours of pattern release\n* Report time: %DATE_TIME\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK\n* Suggestion:\n Check the Agent's Internet connection and update the Agents again.",
"subject": "[%SUBJECT_PREFACE][Action Required] Update deployment rate less than %THRESHOLD% after two hours of pattern release"
}
},
"notify_deployment_rate_crit": 1,
"notify_deployment_rate_warn": 1,
"threshold": {
"0": {
"threshold": 70,
"time_interval": 3600
},
"1": {
"threshold": 90,
"time_interval": 3600
}
}
},
"url_filtering": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Violations: %NUMBER\n* URL blocked: %COUNT\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] URL violations exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"threshold": {
"0": {
"threshold": 301,
"time_interval": 3600
}
}
},
"wtp": {
"msg": {
"0": {
"content": "Trend Micro Worry-Free Business Security Services Notification\n\nNo further action is required.\n* Time period: %FROM to %TO\n* Violations: %NUMBER\n* URL blocked: %COUNT\n* Affected devices:\n%DEVICE_LIST\n See more details on %WEB_CONSOLE_LINK",
"subject": "[%SUBJECT_PREFACE] URL violations exceed %THRESHOLD from %FROM to %TO"
}
},
"notify_incident_exceed": 1,
"threshold": {
"0": {
"threshold": 200,
"time_interval": 3600
}
}
}
}
}
]
}
Name |
Type |
Description |
Length |
|---|---|---|---|
customers[].id |
string |
Customer ID |
GUID |
customers[].eid |
string |
For internal use |
GUID |
customers[].notif_setting |
object |
Notification settings |
Please refer to Notification Settings page |