GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/endpoints
?type={type}
&hostName={hostName}
&machineId={machineId}
&order={order}
&orderDirection={orderDirection}
&pageSize={pageSize}
&pageNr={pageNr}
Gets the list of endpoints on a given GSM site.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
siteId |
The site identifier. |
string |
Required |
type |
Can be set to "active" (returns active endpoints only) or "deactivated" (returns deactivated endpoints only). If this parameter is omitted, endpoints regardless of their activation state are returned. |
string |
None. |
hostName |
Used to search for a particular hostname. |
string |
None. |
machineId |
Used to search for a particular machine. |
string |
None. |
order |
Used to determine the order field. Valid values are "hostname", "firstseen", "lastseen", "agentversion", "lastinfected". Default value is "hostname". |
string |
None. |
orderDirection |
Used to sort the data. "A" for ascending, "D" for descending. If orderDirection is omitted or invalid, the data will be sorted in ascending order. |
string |
None. |
pageSize |
Specifies the number of records being returned. |
integer |
Default value is 50 |
pageNr |
Specifies the page number. Can be used to retrieve the next batch of records. Default value is 1. |
integer |
Default value is 1 |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?type=active
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?hostName=MyComputer1
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?machineId=e12cee848565435b8533ec7540366f13:::9a3ff75d83634d1386af15c238b575fb:::9a3ff75d83634d1386af15c238b575fb
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?pageSize=100&pageNr=3
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?order=lastseen&orderDirection=A
|
Body Parameters
None.
Response Information
Resource Description
Information about the list of endpoints on a given GSM site.
GetEndpointsResponseModelName | Description | Type | Additional Information |
---|---|---|---|
TotalAvailable |
Use this value to determine if you need to retrieve additional pages of data. If TotalAvailable is larger than PageNr * PageSize then more endpoints are available. |
integer |
None. |
PageNr |
The number of the page that was request. |
integer |
None. |
PageSize |
The size of the page that was requested. |
integer |
None. |
Endpoints |
List of endpoint records. |
Collection of GetEndpointsResponseModel_Endpoint |
None. |
Sample Response
{ "TotalAvailable": 2, "PageNr": 1, "PageSize": 50, "Endpoints": [ { "Seq": 1, "EndpointId": "a75aaaaa-b443-4861-a257-de7bdbfda8ef", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2024-02-27T06:07:51.2289299Z", "LastSeen": "2024-02-27T06:07:51.2289299Z", "AgentVersion": "9.0.13.58", "LicenseKey": "622A-B402-B969-446A-9549", "Expired": false, "LastChangesUserId": "01bcd954-55d8-4daa-b81a-e51c6afe96b6", "MachineId": "D4BB14E51F4C4BC3B074B46D7E6CDB8D:::14D19056C60B4F70B3BB343BDC9A45B5:::14D19056C60B4F70B3BB343BDC9A45B5", "PolicyId": "c8d679e1-74c3-443a-a28b-10c67946b0e2", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "699c61f8-4b01-409b-bbfe-116ebdc9d03d", "PolicyName": "Test Policy", "LastInfected": "2024-04-27T06:07:51.2289299Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.181.19.248", "MACAddress": "24-83-03-E7-63-87", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.161.235.82", "Deactivated": false, "LastScanSeq": "1154747694", "ModifiedDate": "2024-07-20T06:07:51.2289299Z" }, { "Seq": 2, "EndpointId": "457b6643-1e86-4952-b4bb-fa8717987c65", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2023-09-27T06:07:51.2289299Z", "LastSeen": "2023-09-27T06:07:51.2289299Z", "AgentVersion": "9.0.13.58", "LicenseKey": "622A-B402-B969-446A-9549", "Expired": false, "LastChangesUserId": "ace8cc12-e33b-43e2-92e2-39004e5ba480", "MachineId": "50C5C6427BD44E1F86A6FABAF8953F2D:::F3E075C62514471D8684AC71441A6465:::F3E075C62514471D8684AC71441A6465", "PolicyId": "9a138f86-092d-4839-93f8-a97ed085da28", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "368f0745-36c5-4a25-bcea-fe36875b59a7", "PolicyName": "Test Policy", "LastInfected": "2024-01-27T06:07:51.2289299Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.177.250.82", "MACAddress": "BE-49-72-E1-9A-E8", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.98.243.83", "Deactivated": false, "LastScanSeq": "2115743299", "ModifiedDate": "2024-07-13T06:07:51.2289299Z" } ] }
<GetEndpointsResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <Endpoints> <GetEndpointsResponseModel_Endpoint> <ADDomain>domain.webroot.com</ADDomain> <ADOU>Webroot.Computers</ADOU> <AgentLanguage>en</AgentLanguage> <AgentVersion>9.0.13.58</AgentVersion> <CurrentUser>Paul</CurrentUser> <Deactivated>false</Deactivated> <EndpointId>a75aaaaa-b443-4861-a257-de7bdbfda8ef</EndpointId> <Expired>false</Expired> <FirstSeen>2024-02-27T06:07:51.2289299Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>699c61f8-4b01-409b-bbfe-116ebdc9d03d</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.181.19.248</InternalIP> <LastChangesUserId>01bcd954-55d8-4daa-b81a-e51c6afe96b6</LastChangesUserId> <LastInfected>2024-04-27T06:07:51.2289299Z</LastInfected> <LastPublicIP>95.161.235.82</LastPublicIP> <LastScanSeq>1154747694</LastScanSeq> <LastSeen>2024-02-27T06:07:51.2289299Z</LastSeen> <LicenseKey>622A-B402-B969-446A-9549</LicenseKey> <MACAddress>24-83-03-E7-63-87</MACAddress> <Mac>false</Mac> <MachineId>D4BB14E51F4C4BC3B074B46D7E6CDB8D:::14D19056C60B4F70B3BB343BDC9A45B5:::14D19056C60B4F70B3BB343BDC9A45B5</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2024-07-20T06:07:51.2289299Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>c8d679e1-74c3-443a-a28b-10c67946b0e2</PolicyId> <PolicyName>Test Policy</PolicyName> <Seq>1</Seq> <VM>false</VM> <WindowsFullOS>Windows 7 Service Pack 1 (Build 7601) 64bit</WindowsFullOS> <Workgroup>WORKGROUP</Workgroup> </GetEndpointsResponseModel_Endpoint> <GetEndpointsResponseModel_Endpoint> <ADDomain>domain.webroot.com</ADDomain> <ADOU>Webroot.Computers</ADOU> <AgentLanguage>en</AgentLanguage> <AgentVersion>9.0.13.58</AgentVersion> <CurrentUser>Paul</CurrentUser> <Deactivated>false</Deactivated> <EndpointId>457b6643-1e86-4952-b4bb-fa8717987c65</EndpointId> <Expired>false</Expired> <FirstSeen>2023-09-27T06:07:51.2289299Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>368f0745-36c5-4a25-bcea-fe36875b59a7</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.177.250.82</InternalIP> <LastChangesUserId>ace8cc12-e33b-43e2-92e2-39004e5ba480</LastChangesUserId> <LastInfected>2024-01-27T06:07:51.2289299Z</LastInfected> <LastPublicIP>95.98.243.83</LastPublicIP> <LastScanSeq>2115743299</LastScanSeq> <LastSeen>2023-09-27T06:07:51.2289299Z</LastSeen> <LicenseKey>622A-B402-B969-446A-9549</LicenseKey> <MACAddress>BE-49-72-E1-9A-E8</MACAddress> <Mac>false</Mac> <MachineId>50C5C6427BD44E1F86A6FABAF8953F2D:::F3E075C62514471D8684AC71441A6465:::F3E075C62514471D8684AC71441A6465</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2024-07-13T06:07:51.2289299Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>9a138f86-092d-4839-93f8-a97ed085da28</PolicyId> <PolicyName>Test Policy</PolicyName> <Seq>2</Seq> <VM>false</VM> <WindowsFullOS>Windows 7 Service Pack 1 (Build 7601) 64bit</WindowsFullOS> <Workgroup>WORKGROUP</Workgroup> </GetEndpointsResponseModel_Endpoint> </Endpoints> <PageNr>1</PageNr> <PageSize>50</PageSize> <TotalAvailable>2</TotalAvailable> </GetEndpointsResponseModel>