GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/groups/{groupId}/endpoints
?order={order}
&orderDirection={orderDirection}
&pageSize={pageSize}
&pageNr={pageNr}
Gets the list of endpoints on a given group.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
siteId |
The site identifier. |
string |
Required |
groupId |
The group identifier. |
string |
Required |
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/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/endpoints
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/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/groups/4f08f3ad-7688-4d40-98a6-89bbf7df3daf/endpoints?order=lastseen&orderDirection=A
|
Body Parameters
None.
Response Information
Resource Description
Information about the list of endpoints on a given group.
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": "4f619498-7b4c-47be-be9f-79367944dbcb", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2025-04-07T02:45:09.9716253Z", "LastSeen": "2025-04-07T02:45:09.9716253Z", "AgentVersion": "9.0.13.58", "LicenseKey": "1FFC-8F01-6953-448E-A70E", "Expired": false, "LastChangesUserId": "078ffa1f-ecb3-448e-b797-8e62623a4875", "MachineId": "0B4D4FA24CCD42E2877AA1AE2D2663FD:::588182B24D854A9DA750AE2033361DC5:::588182B24D854A9DA750AE2033361DC5", "PolicyId": "57bd39ae-6b83-482e-9c31-601df35dbb4b", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "cfbf7f55-7b85-4652-97b5-92d1ff6404b3", "PolicyName": "Test Policy", "LastInfected": "2025-06-07T02:45:09.9716253Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.175.229.204", "MACAddress": "E0-4E-35-87-B0-83", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.153.40.120", "Deactivated": false, "LastScanSeq": "1039302355", "ModifiedDate": "2025-08-31T02:45:09.9716253Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] }, { "Seq": 2, "EndpointId": "0da5e97a-4ce0-4df4-960b-4a0d5d4e5d1a", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-11-07T02:45:09.9716253Z", "LastSeen": "2024-11-07T02:45:09.9716253Z", "AgentVersion": "9.0.13.58", "LicenseKey": "1FFC-8F01-6953-448E-A70E", "Expired": false, "LastChangesUserId": "e9f030dd-90a7-44b1-bdca-a40e53e033fe", "MachineId": "737FE5F753674AFA96DA9419518867F7:::F4D388982B174975AB91753FED832B52:::F4D388982B174975AB91753FED832B52", "PolicyId": "122f1e28-fe79-4b18-9cea-2c566c15c762", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "df0ccd69-a84b-48b1-874c-44f9f9509c54", "PolicyName": "Test Policy", "LastInfected": "2025-03-07T02:45:09.9716253Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.137.96.190", "MACAddress": "58-06-14-86-B4-DA", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.113.173.146", "Deactivated": false, "LastScanSeq": "213012086", "ModifiedDate": "2025-08-24T02:45:09.9716253Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] } ] }
<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> <ActiveModules xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>endpoint</d4p1:string> </ActiveModules> <AgentLanguage>en</AgentLanguage> <AgentVersion>9.0.13.58</AgentVersion> <CurrentUser>Paul</CurrentUser> <Deactivated>false</Deactivated> <EndpointId>4f619498-7b4c-47be-be9f-79367944dbcb</EndpointId> <Expired>false</Expired> <FirstSeen>2025-04-07T02:45:09.9716253Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>cfbf7f55-7b85-4652-97b5-92d1ff6404b3</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.175.229.204</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>078ffa1f-ecb3-448e-b797-8e62623a4875</LastChangesUserId> <LastInfected>2025-06-07T02:45:09.9716253Z</LastInfected> <LastPublicIP>95.153.40.120</LastPublicIP> <LastScanSeq>1039302355</LastScanSeq> <LastSeen>2025-04-07T02:45:09.9716253Z</LastSeen> <LicenseKey>1FFC-8F01-6953-448E-A70E</LicenseKey> <MACAddress>E0-4E-35-87-B0-83</MACAddress> <Mac>false</Mac> <MachineId>0B4D4FA24CCD42E2877AA1AE2D2663FD:::588182B24D854A9DA750AE2033361DC5:::588182B24D854A9DA750AE2033361DC5</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-08-31T02:45:09.9716253Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>57bd39ae-6b83-482e-9c31-601df35dbb4b</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> <ActiveModules xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>endpoint</d4p1:string> </ActiveModules> <AgentLanguage>en</AgentLanguage> <AgentVersion>9.0.13.58</AgentVersion> <CurrentUser>Paul</CurrentUser> <Deactivated>false</Deactivated> <EndpointId>0da5e97a-4ce0-4df4-960b-4a0d5d4e5d1a</EndpointId> <Expired>false</Expired> <FirstSeen>2024-11-07T02:45:09.9716253Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>df0ccd69-a84b-48b1-874c-44f9f9509c54</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.137.96.190</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>e9f030dd-90a7-44b1-bdca-a40e53e033fe</LastChangesUserId> <LastInfected>2025-03-07T02:45:09.9716253Z</LastInfected> <LastPublicIP>95.113.173.146</LastPublicIP> <LastScanSeq>213012086</LastScanSeq> <LastSeen>2024-11-07T02:45:09.9716253Z</LastSeen> <LicenseKey>1FFC-8F01-6953-448E-A70E</LicenseKey> <MACAddress>58-06-14-86-B4-DA</MACAddress> <Mac>false</Mac> <MachineId>737FE5F753674AFA96DA9419518867F7:::F4D388982B174975AB91753FED832B52:::F4D388982B174975AB91753FED832B52</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-08-24T02:45:09.9716253Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>122f1e28-fe79-4b18-9cea-2c566c15c762</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>