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": "ca355d06-ce1d-447c-91a5-2b6d8ef0ba26", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2025-02-28T09:05:48.9563953Z", "LastSeen": "2025-02-28T09:05:48.9563953Z", "AgentVersion": "9.0.13.58", "LicenseKey": "A8AD-11A9-C7AD-426B-BD06", "Expired": false, "LastChangesUserId": "b4c8b699-27a1-46c6-9fce-00cef66c2502", "MachineId": "5B04DCD1FA854A1E924A3A60CB0456FF:::EEED2FABA2FB47E3928E0BA69ECC4327:::EEED2FABA2FB47E3928E0BA69ECC4327", "PolicyId": "713cfb64-1619-4bf0-92ce-998cb71125f9", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "29b710fd-1615-4564-854c-fa2f9acb22f4", "PolicyName": "Test Policy", "LastInfected": "2025-04-28T09:05:48.9563953Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.120.22.83", "MACAddress": "24-FF-94-59-A0-F4", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.187.200.55", "Deactivated": false, "LastScanSeq": "1725223558", "ModifiedDate": "2025-07-21T09:05:48.9563953Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] }, { "Seq": 2, "EndpointId": "4368effd-bb85-40f7-85a1-55d119dbdc57", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-09-28T09:05:48.9563953Z", "LastSeen": "2024-09-28T09:05:48.9563953Z", "AgentVersion": "9.0.13.58", "LicenseKey": "A8AD-11A9-C7AD-426B-BD06", "Expired": false, "LastChangesUserId": "1aa604ca-14d1-44ac-b125-abba3915de78", "MachineId": "4106853FC63941A8998ED86DF60F511F:::138CBAC14C004B978FE29266CC4B8576:::138CBAC14C004B978FE29266CC4B8576", "PolicyId": "5beafb69-41e3-43a2-a583-ef27a707cb52", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "e4441eb0-7e29-4c48-b7e7-ea796fa16d0c", "PolicyName": "Test Policy", "LastInfected": "2025-01-28T09:05:48.9563953Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.27.165.220", "MACAddress": "67-F5-F7-0B-69-81", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.21.104.60", "Deactivated": false, "LastScanSeq": "175291323", "ModifiedDate": "2025-07-14T09:05:48.9563953Z", "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>ca355d06-ce1d-447c-91a5-2b6d8ef0ba26</EndpointId> <Expired>false</Expired> <FirstSeen>2025-02-28T09:05:48.9563953Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>29b710fd-1615-4564-854c-fa2f9acb22f4</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.120.22.83</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>b4c8b699-27a1-46c6-9fce-00cef66c2502</LastChangesUserId> <LastInfected>2025-04-28T09:05:48.9563953Z</LastInfected> <LastPublicIP>95.187.200.55</LastPublicIP> <LastScanSeq>1725223558</LastScanSeq> <LastSeen>2025-02-28T09:05:48.9563953Z</LastSeen> <LicenseKey>A8AD-11A9-C7AD-426B-BD06</LicenseKey> <MACAddress>24-FF-94-59-A0-F4</MACAddress> <Mac>false</Mac> <MachineId>5B04DCD1FA854A1E924A3A60CB0456FF:::EEED2FABA2FB47E3928E0BA69ECC4327:::EEED2FABA2FB47E3928E0BA69ECC4327</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-07-21T09:05:48.9563953Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>713cfb64-1619-4bf0-92ce-998cb71125f9</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>4368effd-bb85-40f7-85a1-55d119dbdc57</EndpointId> <Expired>false</Expired> <FirstSeen>2024-09-28T09:05:48.9563953Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>e4441eb0-7e29-4c48-b7e7-ea796fa16d0c</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.27.165.220</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>1aa604ca-14d1-44ac-b125-abba3915de78</LastChangesUserId> <LastInfected>2025-01-28T09:05:48.9563953Z</LastInfected> <LastPublicIP>95.21.104.60</LastPublicIP> <LastScanSeq>175291323</LastScanSeq> <LastSeen>2024-09-28T09:05:48.9563953Z</LastSeen> <LicenseKey>A8AD-11A9-C7AD-426B-BD06</LicenseKey> <MACAddress>67-F5-F7-0B-69-81</MACAddress> <Mac>false</Mac> <MachineId>4106853FC63941A8998ED86DF60F511F:::138CBAC14C004B978FE29266CC4B8576:::138CBAC14C004B978FE29266CC4B8576</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-07-14T09:05:48.9563953Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>5beafb69-41e3-43a2-a583-ef27a707cb52</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>