Views:

Last Updated: 1/22/2020 12:11:14 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":[  
    {  
      "notif_setting":{  
        "wtp":{  
          "msg":{  
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* URL Violation:                 %NUMBER\n* Report Time:                             %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Web Reputation for further details on %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] Excessive URL violation detected"
            }
          },
          "threshold":{  
            "0":{  
              "threshold":200,
              "time_interval":3600
            }
          },
          "notify_incident_exceed":1
        },
        "recipients":[  

        ],
        "license":{  
          "notify_seat_count_exceed_crit":1,
          "notify_license_expired":1,
          "msg":{  
            "1":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\nYour license has expired on %DATE_TIME. Please contact your vendor for purchase details.\n\n* Worry-Free Business Security Services: %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Action Required] License has expired"
            },
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\nYour license will expire within %DAYS days. Please contact your vendor for purchase details.\n\n* Worry-Free Business Security Services: %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] License expiration is less than %DAYS days"
            },
            "3":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\nMore than %THRESHOLD% of your seat licenses are in use. Please refer to the Live Status/License screen on Worry-Free Business Security Services for further details.\n\n* Worry-Free Business Security Services: %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Action] Seat License usage is greater than %THRESHOLD%"
            },
            "2":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\nMore than %THRESHOLD% of your seat licenses are in use. Please refer to the Live Status/License screen on Worry-Free Business Security Services for further details.\n\n* Worry-Free Business Security Services: %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] Seat License usage is greater than %THRESHOLD%"
            }
          },
          "notify_seat_count_exceed_warn":1,
          "threshold":{  
            "1":{  
              "threshold":110,
              "time_interval":3600
            },
            "0":{  
              "threshold":100,
              "time_interval":3600
            }
          },
          "notify_license_expire_warn":1
        },
        "subject_preface":"ML2_FullA2FullB",
        "update":{  
          "msg":{  
            "1":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\nUpdate rate is %RATE% after %DATE_TIME.\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Update for further details on %WEB_CONSOLE_LINK\n\n* Remediation Procedure:\n    - On Live Status/ Update, click Outdated devices for the list of related device(s).\n    - On Live Status/ Update, click Update Now to deploy updates to clients.",
              "subject":"[%SUBJECT_PREFACE][Action] Update rate less than %THRESHOLD% after one hour of deployment"
            },
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\nUpdate rate is %RATE% after %DATE_TIME.\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Update for further details on %WEB_CONSOLE_LINK\n\n* Remediation Procedure:\n    - On Live Status/ Update, click Outdated devices for the list of related device(s).\n    - On Live Status/ Update, click Update Now to deploy updates to clients.",
              "subject":"[%SUBJECT_PREFACE][Warning] Update rate less than %THRESHOLD% after one hour of deployment"
            }
          },
          "threshold":{  
            "1":{  
              "threshold":90,
              "time_interval":3600
            },
            "0":{  
              "threshold":70,
              "time_interval":3600
            }
          },
          "notify_deployment_rate_warn":1,
          "notify_deployment_rate_crit":1
        },
        "device_control":{  
          "msg":{  
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* Device Control Violations:      %NUMBER\n* Report Time:                 %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Device Control for further details on %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] Excessive Device Control violations detected"
            }
          },
          "threshold":{  
            "0":{  
              "threshold":20,
              "time_interval":3600
            }
          },
          "notify_incident_exceed":1
        },
        "smart_scan":{  
          "msg":{  
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* Failed to connect Smart Scan Server:     %NUMBER\n* Report Time:                             %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Smart Scan for further details on %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] Agents disconnected from Smart Scan Server for the last 30 minutes"
            }
          },
          "notify_cloudscan_connect":1
        },
        "behavior_monitoring":{  
          "msg":{  
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* Behavior Monitoring Violations:              %NUMBER\n* Report Time:                             %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Behavior Monitoring for further details on %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] Excessive Behavior Monitoring violations detected"
            }
          },
          "threshold":{  
            "0":{  
              "threshold":20,
              "time_interval":3600
            }
          },
          "notify_incident_exceed":1
        },
        "url_filtering":{  
          "msg":{  
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* URL Violation:              %NUMBER\n* Report Time:                          %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Url Filtering for further details on %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] Excessive URL category violation detected"
            }
          },
          "threshold":{  
            "0":{  
              "threshold":300,
              "time_interval":3600
            }
          },
          "notify_incident_exceed":1
        },
        "antispyware":{  
          "msg":{  
            "1":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* Spyware/Grayware Detections:              %NUMBER\n* Report Time:                             %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Anti-spyware for further details on %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] Excessive spyware/grayware detected"
            },
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* Detections Requiring Device Restart:    %NUMBER\n* Report Time:                             %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Anti-spyware for further details on %WEB_CONSOLE_LINK\n\n* Remediation Procedure:\n    - On Live Status/ Anti-spyware, click Restart devices required for the list of affected device(s).\n    - Restart the affected clients' device.",
              "subject":"[%SUBJECT_PREFACE][Action] Restart device to complete spyware/grayware cleaning"
            }
          },
          "threshold":{  
            "0":{  
              "threshold":15,
              "time_interval":3600
            }
          },
          "notify_incident_exceed":1,
          "notify_need_restart":1
        },
        "antivirus":{  
          "msg":{  
            "1":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* Virus Detections:                  %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",
              "subject":"[%SUBJECT_PREFACE][Warning] Excessive viruses detected"
            },
            "0":{  
              "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\n\n* Remediation Procedure:\n    - On Live Status/ Antivirus, click Action Unsuccessful for the list of unsuccessful actions.\n    - Click Virus/Malware Name for further clean instruction of the virus/malware.",
              "subject":"[%SUBJECT_PREFACE][Action] Unsuccessful actions on virus"
            },
            "2":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* Real-Time Scan Disabled:                 %NUMBER\n* Report Time:                             %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/Antivirus for further details on %WEB_CONSOLE_LINK\n\n* Remediation Procedure:\n    - On Live Status/ Antivirus, click Real-Time Scan disabled for the list of affected groups.\n    - Enable real-time Antivirus/Anti-spyware at Devices > Configure for the selected group.",
              "subject":"[%SUBJECT_PREFACE][Action] Real-time scan disabled"
            }
          },
          "threshold":{  
            "0":{  
              "threshold":5,
              "time_interval":3600
            }
          },
          "notify_incident_exceed":1,
          "notify_action_failure":1,
          "notify_realtime_scan_disabled":1
        },
        "outbreak":{  
          "msg":{  
            "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"
            },
            "0":{  
              "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] Red alert - %THREAT_NAME"
            }
          },
          "notify_red_alert":1,
          "notify_yellow_alert":1
        },
        "network_virus":{  
          "msg":{  
            "0":{  
              "content":"Trend Micro Worry-Free Business Security Services Notification\n\n* Network Virus Detections:                 %NUMBER\n* Report Time:                             %DATE_TIME\n\n* Affected Device(s):\n- %DEVICE_LIST\n\nRefer to Live Status/ Network Virus for further details on %WEB_CONSOLE_LINK",
              "subject":"[%SUBJECT_PREFACE][Warning] Excessive network viruses detected"
            }
          },
          "threshold":{  
            "0":{  
              "threshold":10,
              "time_interval":3600
            }
          },
          "notify_incident_exceed":1
        }
      },
      "id":"74AE704D-CD9E-4F45-A62B-CA3AED65F99F",
      "eid":"6FA6C13D-04B9-4FBC-B181-9B8AF75AD801"
    }
  ]
}

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