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": "ef35b4f8-b4e1-40e9-87d3-3aeef2185d02", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2024-12-09T17:30:39.3708575Z", "LastSeen": "2024-12-09T17:30:39.3708575Z", "AgentVersion": "9.0.13.58", "LicenseKey": "F031-1F86-ADC2-4A9F-91CC", "Expired": false, "LastChangesUserId": "d12de4e9-81fa-4e69-af89-a74ab42b8539", "MachineId": "0C62CE32DB0745989A1966FCA6879B37:::26D46DF3BA5640D6A70178C6FAEC9E29:::26D46DF3BA5640D6A70178C6FAEC9E29", "PolicyId": "79178734-a8d7-460f-b22e-5d571d5a9482", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "38c340ae-f6c0-4792-947e-d75c8715202c", "PolicyName": "Test Policy", "LastInfected": "2025-02-09T17:30:39.3708575Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.141.232.208", "MACAddress": "D1-1B-CB-C2-68-FE", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.91.226.195", "Deactivated": false, "LastScanSeq": "1574502578", "ModifiedDate": "2025-05-02T17:30:39.3708575Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] }, { "Seq": 2, "EndpointId": "bd157244-77c5-43a9-9421-78b5be786cf4", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-07-09T17:30:39.3708575Z", "LastSeen": "2024-07-09T17:30:39.3708575Z", "AgentVersion": "9.0.13.58", "LicenseKey": "F031-1F86-ADC2-4A9F-91CC", "Expired": false, "LastChangesUserId": "3a8dd415-0e8b-4b5b-af94-649e0923ce4a", "MachineId": "2A28CF00BCF24661ADA399E6BB464EC0:::EDEC0079AB024B8A90676EDEC2266E42:::EDEC0079AB024B8A90676EDEC2266E42", "PolicyId": "10f5186c-cf61-4c5b-892f-baffc6d44613", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "5b50ee3f-a481-4c47-8603-c8cf452a579f", "PolicyName": "Test Policy", "LastInfected": "2024-11-09T17:30:39.3708575Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.233.104.48", "MACAddress": "2F-F6-FB-77-88-E8", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.127.235.34", "Deactivated": false, "LastScanSeq": "971349083", "ModifiedDate": "2025-04-25T17:30:39.3708575Z", "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>ef35b4f8-b4e1-40e9-87d3-3aeef2185d02</EndpointId> <Expired>false</Expired> <FirstSeen>2024-12-09T17:30:39.3708575Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>38c340ae-f6c0-4792-947e-d75c8715202c</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.141.232.208</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>d12de4e9-81fa-4e69-af89-a74ab42b8539</LastChangesUserId> <LastInfected>2025-02-09T17:30:39.3708575Z</LastInfected> <LastPublicIP>95.91.226.195</LastPublicIP> <LastScanSeq>1574502578</LastScanSeq> <LastSeen>2024-12-09T17:30:39.3708575Z</LastSeen> <LicenseKey>F031-1F86-ADC2-4A9F-91CC</LicenseKey> <MACAddress>D1-1B-CB-C2-68-FE</MACAddress> <Mac>false</Mac> <MachineId>0C62CE32DB0745989A1966FCA6879B37:::26D46DF3BA5640D6A70178C6FAEC9E29:::26D46DF3BA5640D6A70178C6FAEC9E29</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-05-02T17:30:39.3708575Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>79178734-a8d7-460f-b22e-5d571d5a9482</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>bd157244-77c5-43a9-9421-78b5be786cf4</EndpointId> <Expired>false</Expired> <FirstSeen>2024-07-09T17:30:39.3708575Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>5b50ee3f-a481-4c47-8603-c8cf452a579f</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.233.104.48</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>3a8dd415-0e8b-4b5b-af94-649e0923ce4a</LastChangesUserId> <LastInfected>2024-11-09T17:30:39.3708575Z</LastInfected> <LastPublicIP>95.127.235.34</LastPublicIP> <LastScanSeq>971349083</LastScanSeq> <LastSeen>2024-07-09T17:30:39.3708575Z</LastSeen> <LicenseKey>F031-1F86-ADC2-4A9F-91CC</LicenseKey> <MACAddress>2F-F6-FB-77-88-E8</MACAddress> <Mac>false</Mac> <MachineId>2A28CF00BCF24661ADA399E6BB464EC0:::EDEC0079AB024B8A90676EDEC2266E42:::EDEC0079AB024B8A90676EDEC2266E42</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-04-25T17:30:39.3708575Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>10f5186c-cf61-4c5b-892f-baffc6d44613</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>