Last Updated: 1/22/2020 12:11:04 AM
Get the latest livestatus of given customers.
Request
HTTP Request
GET /SMPI/{version}/service/wfbss/api/customers/livestatus
Parameters
Name |
Type |
Description |
Validation |
|---|---|---|---|
|
Optional Parameters |
|||
cids |
string |
A list of customer IDs separated by comma. |
At least one customer ID must be specified, and no more than 10. |
page |
integer |
Page number |
1 to max. If not set, default is 1. |
limit |
integer |
Number of records per page |
1 to 100. If not set, default is 25. |
begin_time |
integer |
Query live status updated after the given time. |
Unix timestamp (seconds since 1970-01-01 00:00:00 UTC) |
HTTP Request Example
Get the latest livestatus of all your customers (page 1 and 25 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/livestatus
Get the latest livestatus of all your customers (page 2 and 50 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/livestatus?page=2&limit=50
Get the latest livestatus of specific customers (page 1 and 25 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/livestatus?cids=640FE47F-5118-4D79-8221-A35D0DE2EE2C,549390C2-61B3-417E-B1F0-8955A63C08F3
Get the latest livestatus updated after a specific time (page 1 and 25 records per page):
GET /SMPI/{version}/service/wfbss/api/customers/livestatus?begin_time=1370315252
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:
{
"paging":{
"total":1,
"limit":25,
"page":1
},
"customers":[
{
"id":"640FE47F-5118-4D79-8221-A35D0DE2EE2C",
"livestatus":{
"wtp":{
"light":0,
"incident_exceed":{
"count":0,
"start_time":0,
"end_time":0
}
},
"update_time":1420704637,
"license":{
"light":2,
"desktop_seat_in_use":0,
"seat_in_use":0,
"expiration_state":2,
"seat_count_exceed":0,
"seat_in_use_percentage":"0.0",
"seat_purchase":10,
"expiration_date":1420703999,
"mobile_seat_in_use":0
},
"threat_light":0,
"license_status_light":2,
"update":{
"light":0,
"outdated_computer":0,
"datetime":0
},
"device_control":{
"light":0,
"incident_exceed":{
"count":0,
"start_time":0,
"end_time":0
}
},
"smart_scan":{
"light":0,
"unsuccessful":0
},
"behavior_monitoring":{
"light":0,
"incident_exceed":{
"count":0,
"start_time":0,
"end_time":0
}
},
"url_filtering":{
"light":0,
"incident_exceed":{
"count":0,
"start_time":0,
"end_time":0
}
},
"antispyware":{
"light":0,
"incident_exceed":{
"light":0,
"count":0,
"start_time":0,
"end_time":0
},
"computer_restart_required":{
"light":0,
"count":0,
"start_time":0,
"end_time":0
}
},
"antivirus":{
"light":0,
"incident_exceed":{
"light":0,
"count":0,
"start_time":0,
"end_time":0
},
"action_unsuccessful":{
"light":0,
"count":0,
"start_time":0,
"end_time":0
},
"realtime_scan_disabled":0,
"realtime_scan_disabled_light":0
},
"system_light":0,
"outbreak":{
"threat_name":"",
"alert_disabled":0,
"alert_enabled":0,
"light":0
},
"network_virus":{
"light":0,
"incident_exceed":{
"count":0,
"start_time":0,
"end_time":0
}
}
},
"eid":"6FA6C13D-04B9-4FBC-B181-9B8AF75AD801"
}
]
}
Name |
Type |
Description |
Length |
|---|---|---|---|
paging.total |
integer |
The total number of records |
|
paging.limit |
integer |
The number of records per page |
1 to 100 |
paging.page |
integer |
page number |
1 to max |
customers[].id |
string |
Customer ID |
GUID |
customers[].eid |
string |
For internal use |
GUID |
customers[].livestatus.update_time |
integer |
Generated time of this live status |
Unix timestamp |
customers[].livestatus.threat_light |
integer |
The icon of Threat Status event category |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.license_status_light |
integer |
The icon of License Status event category |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.system_light |
integer |
The icon of System Status event category |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.wtp.light |
integer |
The icon of Web Reputation event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.wtp.incident_exceed.count |
integer |
The number of URL violation in Web Reputation |
|
customers[].livestatus.wtp.incident_exceed.start_time |
integer |
The time interval of URL violation in Web Reputation |
Unix timestamp |
customers[].livestatus.wtp.incident_exceed.end_time |
integer |
The time interval of of URL violation in Web Reputation |
Unix timestamp |
customers[].livestatus.license.expiration_state |
integer |
License status |
0 = not expired, 1 = near to expiration, 2 = expired |
customers[].livestatus.license.desktop_seat_in_use |
integer |
Seats in use - Desktop/Server |
|
customers[].livestatus.license.seat_in_use |
integer |
Seats in use. For JP, this number will be the sum of desktop and mobile seats in use, while global is only the count of desktop seats in use (mobile seats are free). |
|
customers[].livestatus.license.light |
integer |
The icon of License event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.license.expiration_date |
integer |
License expiration date |
Unix timestamp |
customers[].livestatus.license.seat_purchase |
integer |
Seats purchased |
|
customers[].livestatus.license.seat_count_exceed |
integer |
The number of seats in use exceeds than the number of seats purchased. |
0 = not to exceed; 1 = exceed 80%, 2 = exceed 100% |
customers[].livestatus.license.mobile_seat_in_use |
integer |
Seats in use - Mobile |
|
customers[].livestatus.license.seat_in_use_percentage |
float |
The percentage of seats in use |
e.g., 98.8 |
customers[].livestatus.update.light |
integer |
The icon of Update event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.update.outdated_computer |
integer |
The number of out-dated devices |
|
customers[].livestatus.antivirus.light |
integer |
The icon of Antivirus event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.antivirus.realtime_scan_disabled |
integer |
The number of realtime scan disabled |
|
customers[].livestatus.antivirus.realtime_scan_disabled_light |
integer |
The icon of realtime scan disabled |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.antivirus.incident_exceed.count |
integer |
The number of virus detections |
|
customers[].livestatus.antivirus.incident_exceed.light |
integer |
The icon of virus detections |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.antivirus.incident_exceed.start_time |
integer |
The time interval of virus detections |
Unix timestamp |
customers[].livestatus.antivirus.incident_exceed.end_time |
integer |
The time interval of virus detections |
Unix timestamp |
customers[].livestatus.antivirus.action_unsuccessful.count |
integer |
The number of action unsuccessful |
|
customers[].livestatus.antivirus.action_unsuccessful.light |
integer |
The icon of action unsuccessful |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.antivirus.action_unsuccessful.start_time |
integer |
The time interval of action unsuccessful |
Unix timestamp |
customers[].livestatus.antivirus.action_unsuccessful.end_time |
integer |
The time interval of action unsuccessful |
Unix timestamp |
customers[].livestatus.smart_scan.light |
integer |
The icon of Smart Scan event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.smart_scan.unsuccessful |
integer |
The number of agents disconnected |
|
customers[].livestatus.behavior_monitoring.light |
integer |
The icon of Behavior Monitoring event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.behavior_monitoring.incident_exceed.count |
integer |
The number of Behavior Monitoring violations |
|
customers[].livestatus.behavior_monitoring.incident_exceed.start_time |
integer |
The time interval of Behavior Monitoring violations |
Unix timestamp |
customers[].livestatus.behavior_monitoring.incident_exceed.end_time |
integer |
The time interval of Behavior Monitoring violations |
Unix timestamp |
customers[].livestatus.url_filtering.light |
integer |
The icon of URL Filtering event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.url_filtering.incident_exceed.count |
integer |
The number of URL violation in URL Filtering |
|
customers[].livestatus.url_filtering.incident_exceed.start_time |
integer |
The time interval of URL violation in URL Filtering |
Unix timestamp |
customers[].livestatus.url_filtering.incident_exceed.end_time |
integer |
The time interval of URL violation in URL Filtering |
Unix timestamp |
customers[].livestatus.antispyware.light |
integer |
The icon of Anti-spyware event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.antispyware.incident_exceed.count |
integer |
The number of Spyware/Grayware detections |
|
customers[].livestatus.antispyware.incident_exceed.light |
integer |
The icon of Spyware/Grayware detections |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.antispyware.incident_exceed.start_time |
integer |
The time interval of Spyware/Grayware detections |
|
customers[].livestatus.antispyware.incident_exceed.end_time |
integer |
The time interval of Spyware/Grayware detections |
|
customers[].livestatus.antispyware.computer_restart_required.count |
integer |
The number of detections requiring device restart |
|
customers[].livestatus.antispyware.computer_restart_required.light |
integer |
The icon of detections requiring device restart |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.antispyware.computer_restart_required.start_time |
integer |
The time interval of detections requiring device restart |
Unix timestamp |
customers[].livestatus.antispyware.computer_restart_required.end_time |
integer |
The time interval of detections requiring device restart |
Unix timestamp |
customers[].livestatus.network_virus.light |
integer |
The icon of Network Virus event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.network_virus.incident_exceed.count |
integer |
The number of network virus detections |
|
customers[].livestatus.network_virus.incident_exceed.start_time |
integer |
The time interval of network virus detections |
Unix timestamp |
customers[].livestatus.network_virus.incident_exceed.end_time |
integer |
The time interval of network virus detections |
Unix timestamp |
customers[].livestatus.outbreak.threat_name |
string |
Threat name |
|
customers[].livestatus.outbreak.alert_disabled |
integer |
The number of devices having Outbreak prevention disabled |
|
customers[].livestatus.outbreak.alert_enabled |
integer |
he number of devices having Outbreak prevention enabled |
|
customers[].livestatus.outbreak.light |
integer |
The icon of Outbreak Defense event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.device_control.light |
integer |
The icon of Device Control event |
0 = Green, 1 = Yellow, 2 = Red |
customers[].livestatus.device_control.incident_exceed.count |
integer |
The number of Device Control violations |
|
customers[].livestatus.device_control.incident_exceed.start_time |
integer |
The time interval of Device Control violations |
Unix timestamp |
customers[].livestatus.device_control.incident_exceed.end_time |
integer |
The time interval of Device Control violations |
Unix timestamp |
customers[].livestatus.ransomware.light |
integer |
The icon of Ransomware event |
0 = Green, 1 = Yellow |
customers[].livestatus.ransomware.start_time |
integer |
The time interval of Ransomware detections |
Unix timestamp |
customers[].livestatus.ransomware.end_time |
integer |
The time interval of Ransomware detections |
Unix timestamp |
customers[].livestatus.ransomware.ransomware_incident_count |
integer |
The total number of encryption attempts blocked |
integer |
customers[].livestatus.ransomware.ransomware_device_count |
integer |
The total number of affected devices |
integer |
customers[].livestatus.ransomware.ransomware_threat_count |
integer |
The total number of ransomware |
integer |