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": "2e65e479-f982-4fea-b849-29dfa27f4e9b", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2025-03-17T14:13:25.3528851Z", "LastSeen": "2025-03-17T14:13:25.3528851Z", "AgentVersion": "9.0.13.58", "LicenseKey": "B247-AA6D-19CA-43D9-B75F", "Expired": false, "LastChangesUserId": "41f1ec18-97d0-45b1-9900-7701c28641a8", "MachineId": "B547E0C0BA1848A6B0156A1563E8FC5A:::9AE67AD832E549C19C8B7C8F67A39716:::9AE67AD832E549C19C8B7C8F67A39716", "PolicyId": "47575126-2bd9-4668-8fdc-7cb6dbcfe463", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "ec3df560-7380-4305-9dfb-fe9a1f6f0c4f", "PolicyName": "Test Policy", "LastInfected": "2025-05-17T14:13:25.3528851Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.20.181.201", "MACAddress": "03-EB-40-88-8A-C9", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.215.146.97", "Deactivated": false, "LastScanSeq": "1271673119", "ModifiedDate": "2025-08-10T14:13:25.3528851Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] }, { "Seq": 2, "EndpointId": "935a4cc3-aeb8-4efe-a313-e5d96b22056f", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-10-17T14:13:25.3528851Z", "LastSeen": "2024-10-17T14:13:25.3528851Z", "AgentVersion": "9.0.13.58", "LicenseKey": "B247-AA6D-19CA-43D9-B75F", "Expired": false, "LastChangesUserId": "e1ed7009-49bb-416f-91f1-a5a5e73f723b", "MachineId": "5ADC07DF0DDC4DA6BABD80A25D610F0B:::98CD34FC3961415BAD52F461BACF73AB:::98CD34FC3961415BAD52F461BACF73AB", "PolicyId": "004439fe-1303-4a32-ba7c-2be4c341d652", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "8eecaae2-c34c-4210-a066-7ea52d4304de", "PolicyName": "Test Policy", "LastInfected": "2025-02-17T14:13:25.3528851Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.32.39.243", "MACAddress": "2B-95-46-9F-2D-90", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.177.28.220", "Deactivated": false, "LastScanSeq": "540734591", "ModifiedDate": "2025-08-03T14:13:25.3528851Z", "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>2e65e479-f982-4fea-b849-29dfa27f4e9b</EndpointId> <Expired>false</Expired> <FirstSeen>2025-03-17T14:13:25.3528851Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>ec3df560-7380-4305-9dfb-fe9a1f6f0c4f</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.20.181.201</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>41f1ec18-97d0-45b1-9900-7701c28641a8</LastChangesUserId> <LastInfected>2025-05-17T14:13:25.3528851Z</LastInfected> <LastPublicIP>95.215.146.97</LastPublicIP> <LastScanSeq>1271673119</LastScanSeq> <LastSeen>2025-03-17T14:13:25.3528851Z</LastSeen> <LicenseKey>B247-AA6D-19CA-43D9-B75F</LicenseKey> <MACAddress>03-EB-40-88-8A-C9</MACAddress> <Mac>false</Mac> <MachineId>B547E0C0BA1848A6B0156A1563E8FC5A:::9AE67AD832E549C19C8B7C8F67A39716:::9AE67AD832E549C19C8B7C8F67A39716</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-08-10T14:13:25.3528851Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>47575126-2bd9-4668-8fdc-7cb6dbcfe463</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>935a4cc3-aeb8-4efe-a313-e5d96b22056f</EndpointId> <Expired>false</Expired> <FirstSeen>2024-10-17T14:13:25.3528851Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>8eecaae2-c34c-4210-a066-7ea52d4304de</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.32.39.243</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>e1ed7009-49bb-416f-91f1-a5a5e73f723b</LastChangesUserId> <LastInfected>2025-02-17T14:13:25.3528851Z</LastInfected> <LastPublicIP>95.177.28.220</LastPublicIP> <LastScanSeq>540734591</LastScanSeq> <LastSeen>2024-10-17T14:13:25.3528851Z</LastSeen> <LicenseKey>B247-AA6D-19CA-43D9-B75F</LicenseKey> <MACAddress>2B-95-46-9F-2D-90</MACAddress> <Mac>false</Mac> <MachineId>5ADC07DF0DDC4DA6BABD80A25D610F0B:::98CD34FC3961415BAD52F461BACF73AB:::98CD34FC3961415BAD52F461BACF73AB</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-08-03T14:13:25.3528851Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>004439fe-1303-4a32-ba7c-2be4c341d652</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>