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": "88d143f5-2646-4ef2-8811-b08036fdf61c", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2025-04-13T01:28:23.0663983Z", "LastSeen": "2025-04-13T01:28:23.0663983Z", "AgentVersion": "9.0.13.58", "LicenseKey": "2633-8C43-E6F6-4694-8E2D", "Expired": false, "LastChangesUserId": "798e16f5-7521-49b8-8d6c-1915b55514b4", "MachineId": "1399A3A63D4043C98B631B011151030D:::2824C96268E34DAD9405FCAFACBE2A4C:::2824C96268E34DAD9405FCAFACBE2A4C", "PolicyId": "3fab44c7-2a3c-4e72-94db-28fbf3d39970", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "78b5eb9f-99d6-442d-b930-707a01dfcaf2", "PolicyName": "Test Policy", "LastInfected": "2025-06-13T01:28:23.0663983Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.202.24.147", "MACAddress": "2F-86-F4-95-25-64", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.3.58.206", "Deactivated": false, "LastScanSeq": "705192825", "ModifiedDate": "2025-09-06T01:28:23.0663983Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] }, { "Seq": 2, "EndpointId": "5b97863e-6689-4253-8fa3-1428cf07a36a", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-11-13T01:28:23.0663983Z", "LastSeen": "2024-11-13T01:28:23.0663983Z", "AgentVersion": "9.0.13.58", "LicenseKey": "2633-8C43-E6F6-4694-8E2D", "Expired": false, "LastChangesUserId": "5ac6ffc0-c335-439f-9f14-19847ea6c1be", "MachineId": "EE4044E427FE45F792B6A469BD2EA374:::E9DBC69CA97E4EAE86D48C766EC2644E:::E9DBC69CA97E4EAE86D48C766EC2644E", "PolicyId": "d857ff5c-01a2-4c73-a97b-0d2725b156bf", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "6b83d43d-ccf5-4e26-b717-9b9a050f0c19", "PolicyName": "Test Policy", "LastInfected": "2025-03-13T01:28:23.0663983Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.120.50.151", "MACAddress": "A9-BC-B5-05-BA-F8", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.235.197.0", "Deactivated": false, "LastScanSeq": "625114541", "ModifiedDate": "2025-08-30T01:28:23.0663983Z", "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>88d143f5-2646-4ef2-8811-b08036fdf61c</EndpointId> <Expired>false</Expired> <FirstSeen>2025-04-13T01:28:23.0663983Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>78b5eb9f-99d6-442d-b930-707a01dfcaf2</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.202.24.147</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>798e16f5-7521-49b8-8d6c-1915b55514b4</LastChangesUserId> <LastInfected>2025-06-13T01:28:23.0663983Z</LastInfected> <LastPublicIP>95.3.58.206</LastPublicIP> <LastScanSeq>705192825</LastScanSeq> <LastSeen>2025-04-13T01:28:23.0663983Z</LastSeen> <LicenseKey>2633-8C43-E6F6-4694-8E2D</LicenseKey> <MACAddress>2F-86-F4-95-25-64</MACAddress> <Mac>false</Mac> <MachineId>1399A3A63D4043C98B631B011151030D:::2824C96268E34DAD9405FCAFACBE2A4C:::2824C96268E34DAD9405FCAFACBE2A4C</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-09-06T01:28:23.0663983Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>3fab44c7-2a3c-4e72-94db-28fbf3d39970</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>5b97863e-6689-4253-8fa3-1428cf07a36a</EndpointId> <Expired>false</Expired> <FirstSeen>2024-11-13T01:28:23.0663983Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>6b83d43d-ccf5-4e26-b717-9b9a050f0c19</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.120.50.151</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>5ac6ffc0-c335-439f-9f14-19847ea6c1be</LastChangesUserId> <LastInfected>2025-03-13T01:28:23.0663983Z</LastInfected> <LastPublicIP>95.235.197.0</LastPublicIP> <LastScanSeq>625114541</LastScanSeq> <LastSeen>2024-11-13T01:28:23.0663983Z</LastSeen> <LicenseKey>2633-8C43-E6F6-4694-8E2D</LicenseKey> <MACAddress>A9-BC-B5-05-BA-F8</MACAddress> <Mac>false</Mac> <MachineId>EE4044E427FE45F792B6A469BD2EA374:::E9DBC69CA97E4EAE86D48C766EC2644E:::E9DBC69CA97E4EAE86D48C766EC2644E</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-08-30T01:28:23.0663983Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>d857ff5c-01a2-4c73-a97b-0d2725b156bf</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>