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": "447e7b37-ffb6-4b0b-9148-e66d5252402d", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2025-05-08T18:47:05.8203501Z", "LastSeen": "2025-05-08T18:47:05.8203501Z", "AgentVersion": "9.0.13.58", "LicenseKey": "6B82-23A8-B55E-443C-8E75", "Expired": false, "LastChangesUserId": "dbdba97f-07de-4213-8ab2-fe75b701ecff", "MachineId": "52654AAB39594A048FBF88A633AC9B21:::DF01A0080F7546AD9132D7C344410B74:::DF01A0080F7546AD9132D7C344410B74", "PolicyId": "f9face1d-484b-4f73-933a-a3a782bbb9f9", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "951c3242-1b6b-4ef9-a911-4b8193a45639", "PolicyName": "Test Policy", "LastInfected": "2025-07-08T18:47:05.8203501Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.202.213.92", "MACAddress": "6E-FC-6B-14-D8-AC", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.96.21.128", "Deactivated": false, "LastScanSeq": "971861345", "ModifiedDate": "2025-10-01T18:47:05.8203501Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] }, { "Seq": 2, "EndpointId": "4acb3629-deaa-452c-9310-3ad12bedb450", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-12-08T18:47:05.8203501Z", "LastSeen": "2024-12-08T18:47:05.8203501Z", "AgentVersion": "9.0.13.58", "LicenseKey": "6B82-23A8-B55E-443C-8E75", "Expired": false, "LastChangesUserId": "0c0b7d6b-7cee-4969-81ce-35e220a779a9", "MachineId": "BAA4134B48BF488B9336F57E3CA8803E:::353BF51512854828971179BCC92E66C2:::353BF51512854828971179BCC92E66C2", "PolicyId": "2926046b-e61e-4411-bb61-51d8a71e362e", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "ea548d46-ba64-4d98-9c41-4c068d4beb19", "PolicyName": "Test Policy", "LastInfected": "2025-04-08T18:47:05.8203501Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.186.205.117", "MACAddress": "4F-5D-C4-DB-22-79", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.119.203.108", "Deactivated": false, "LastScanSeq": "16721097", "ModifiedDate": "2025-09-24T18:47:05.8203501Z", "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>447e7b37-ffb6-4b0b-9148-e66d5252402d</EndpointId> <Expired>false</Expired> <FirstSeen>2025-05-08T18:47:05.8203501Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>951c3242-1b6b-4ef9-a911-4b8193a45639</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.202.213.92</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>dbdba97f-07de-4213-8ab2-fe75b701ecff</LastChangesUserId> <LastInfected>2025-07-08T18:47:05.8203501Z</LastInfected> <LastPublicIP>95.96.21.128</LastPublicIP> <LastScanSeq>971861345</LastScanSeq> <LastSeen>2025-05-08T18:47:05.8203501Z</LastSeen> <LicenseKey>6B82-23A8-B55E-443C-8E75</LicenseKey> <MACAddress>6E-FC-6B-14-D8-AC</MACAddress> <Mac>false</Mac> <MachineId>52654AAB39594A048FBF88A633AC9B21:::DF01A0080F7546AD9132D7C344410B74:::DF01A0080F7546AD9132D7C344410B74</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-10-01T18:47:05.8203501Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>f9face1d-484b-4f73-933a-a3a782bbb9f9</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>4acb3629-deaa-452c-9310-3ad12bedb450</EndpointId> <Expired>false</Expired> <FirstSeen>2024-12-08T18:47:05.8203501Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>ea548d46-ba64-4d98-9c41-4c068d4beb19</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.186.205.117</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>0c0b7d6b-7cee-4969-81ce-35e220a779a9</LastChangesUserId> <LastInfected>2025-04-08T18:47:05.8203501Z</LastInfected> <LastPublicIP>95.119.203.108</LastPublicIP> <LastScanSeq>16721097</LastScanSeq> <LastSeen>2024-12-08T18:47:05.8203501Z</LastSeen> <LicenseKey>6B82-23A8-B55E-443C-8E75</LicenseKey> <MACAddress>4F-5D-C4-DB-22-79</MACAddress> <Mac>false</Mac> <MachineId>BAA4134B48BF488B9336F57E3CA8803E:::353BF51512854828971179BCC92E66C2:::353BF51512854828971179BCC92E66C2</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-09-24T18:47:05.8203501Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>2926046b-e61e-4411-bb61-51d8a71e362e</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>