WFBSS :: Components :: get | Trend Micro Service Central

Views:

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

Get device information for one customer.

Request

HTTP Request

GET /SMPI/{version}/service/wfbss/api/components

Name	Type	Description	Validation
Required Parameters
cids	string	Customer ID	Only accept one Customer ID
Optional Parameters
ccids	string	A list of device ID seperated by comma.	The number of ccids must less than 100. ccids beyond that will be ignored.
fields	string	A list of components separated by comma. If set, only the specified fields will be returned. Otherwise, except for extra fields, all the other fields will be returned.	Valid values: aa ,ip_addr ,platform ,arch ,components ,version ,scan_mode ,ss_service ,pop3_scan ,virus_detected ,spyware_detected ,spam_detected ,urlfilter_violated ,type ,status ,phone_number ,mac_addr ,last_connect_time ,sched_start_time ,sched_complete_time ,manual_start_time ,manual_complete_time
extra_fields	string	A list of components separated by comma. If set, the specified extra fields will be returned. Otherwise, extra fields will not be returned.	Valid value: group_name, label, and out_of_date
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 100

HTTP Request Example

1. Get device information for one customer:
GET /SMPI/{version}/service/wfbss/api/components?cids=AD38F82D-51A1-46FD-B167-E0D0FF31BE83&amp;page=1&amp;limit=25

2. Get device information for specific devices of a customer:
GET /SMPI/{version}/service/wfbss/api/components?cids=AD38F82D-51A1-46FD-B167-E0D0FF31BE83&amp;ccids=c221af4b946cf34a889be2e6116995dc,d2f871c7641fd747881e88b87745ac8b

3. Get specific device information for one customer:
GET /SMPI/{version}/service/wfbss/api/components?cids=AD38F82D-51A1-46FD-B167-E0D0FF31BE83&amp;fields=platform,arch

Request Body

Do not supply a request body with this method.

Response

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

{
  "customers": [
    {
      "computers": [
        {
          "aa": True,
          "arch": "Intel",
          "components": [
            {
              "type": 1,
              "version": "5.879.00"
            },
            {
              "type": 15,
              "version": "9.500.1010"
            }
          ],
          "id": "c221af4b946cf34a889be2e6116995dc",
          "ip_addr": "10.201.175.127",
          "last_connect_time": 1390815681,
          "mac_addr": "00:0c:29:75:50:88",
          "manual_complete_time": 0,
          "manual_scan_time": 0,
          "manual_start_time": 0,
          "name": "wfbsss-Mac-2",
          "online": False,
          "phone_number": "",
          "platform": "Mac OS X 10.9.0",
          "pop3_scan": False,
          "scan_mode": 1,
          "sched_complete_time": 0,
          "sched_scan_time": 0,
          "sched_start_time": 0,
          "spam_detected": 0,
          "spyware_detected": 0,
          "ss_service": False,
          "status": 2,
          "type": 3,
          "urlfilter_violated": 0,
          "version": "1.7.2822",
          "virus_detected": 0
        },
        {
          "aa": True,
          "arch": "Intel",
          "components": [
            {
              "type": 1,
              "version": "5.879.00"
            },
            {
              "type": 15,
              "version": "9.500.1010"
            }
          ],
          "id": "d2f871c7641fd747881e88b87745ac8b",
          "ip_addr": "10.211.55.6",
          "last_connect_time": 1391761546,
          "mac_addr": "00:1c:42:d9:c4:87",
          "manual_complete_time": 0,
          "manual_scan_time": 0,
          "manual_start_time": 0,
          "name": "Tommy-MacBook-Pro-Parallels",
          "online": False,
          "phone_number": "",
          "platform": "Mac OS X 10.8.2",
          "pop3_scan": False,
          "scan_mode": 1,
          "sched_complete_time": 0,
          "sched_scan_time": 0,
          "sched_start_time": 0,
          "spam_detected": 0,
          "spyware_detected": 0,
          "ss_service": False,
          "status": 2,
          "type": 3,
          "urlfilter_violated": 0,
          "version": "1.7.1000",
          "virus_detected": 0
        }
      ],
      "count": 2,
      "eid": "37C48037-7C87-4945-93A6-E09999189FAB",
      "id": "AD38F82D-51A1-46FD-B167-E0D0FF31BE83"
    }
  ],
  "paging": {
    "limit": 25,
    "page": 1,
    "total": 2
  }
}

Name	Type	Description	Length
paging.total	integer	The total number of devices
paging.limit	integer	The number of devices per page	1 to 100
paging.page	integer	Current page number	1 to max
customers[].id	string	Customer ID	GUID
customers[].eid	string	Internal use only	GUID
customers[].count	integer	The total number of devices
customers[].computers[].id	string	Device ID
customers[].computers[].name	string	Device name
customers[].computers[].type	integer	Device Type	1 = windows desktop, 2 = windows server, 3 = MAC desktop, 4 = MAC server, 5 = Android device, 6 = IOS device
customers[].computers[].aa	boolean	Active Agent or not	True = Active Agent; False = Inactive Agent
customers[].computers[].phone_number	string	Mobile Phone
customers[].computers[].ip_addr	string	IP Address
customers[].computers[].mac_addr	string	MAC Address
customers[].computers[].status	integer	Device status	For Windows device, 1 = device Online; 2 = Offline. For Mac device, 1 = Online; 2 = Offline. For Android device, 3 = Normal; 4 = Warning.
customers[].computers[].last_connect_time	integer	Last Connect Time	Unix timestamp
customers[].computers[].virus_detected	integer	Virus Detected
customers[].computers[].spyware_detected	integer	Spyware Detected
customers[].computers[].spam_detected	integer	Spam Detected
customers[].computers[].urlfilter_violated	integer	URL Filtering Violation
customers[].computers[].ss_service	boolean	Smart Scan Server	True = Connected; False = unconnected
customers[].computers[].components[].version	string	Engine/Pattern Version
customers[].computers[].components[].type	integer	Engine/Pattern Type	1 = VSAPI pattern; 2 = VSAPI engine 32; 3 = VSAPI engine 64; 4 = Smart scan(ICRC) pattern; 5 = VSAPI engine for Mac; 6 = Android PATTERN; 7 = Android Engine
customers[].computers[].sched_scan_time	integer	This filed is deprecated
customers[].computers[].sched_complete_time	integer	Scheduled Scan Start Time
customers[].computers[].sched_start_time	integer	Scheduled Scan Complete Time
customers[].computers[].manual_scan_time	integer	This filed is deprecated
customers[].computers[].manual_start_time	integer	Scheduled Scan Start Time	Unix timestamp
customers[].computers[].manual_complete_time	integer	Scheduled Scan Complete Time	Unix timestamp
customers[].computers[].pop3_scan	boolean	POP3 Scan	True = enabled; False = disabled
customers[].computers[].scan_mode	integer	Scan Method	0 = Smart Scan; 1 = Conventional Scan
customers[].computers[].version	string	Client Version
customers[].computers[].platform	string	Operating System
customers[].computers[].arch	string	Architecture
customers[].computers[].online	integer	This filed is deprecated
customers[].computers[].last_logon_user_account	string	Internal use only
customers[].computers[].last_logon_user_domain	string	Internal use only
customers[].computers[].last_logon_user_guid	string	Internal use only
customers[].computers[].group_name	string	Group name
customers[].computers[].label	string	Device label
customers[].computers[].out_of_date	boolean	Outdated or not	True = outdated; False = not outdated. This field is only available for Windows platform.