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": "75cb030f-3d41-4337-95a7-2fccde295dd2", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2024-12-30T18:37:13.7796561Z", "LastSeen": "2024-12-30T18:37:13.7796561Z", "AgentVersion": "9.0.13.58", "LicenseKey": "54E6-9F23-4E0B-4DF5-AF9B", "Expired": false, "LastChangesUserId": "ad4af759-54ce-4109-95c0-04a0816ccc43", "MachineId": "A51294EB6627479AB01CB611CE3AC0C9:::3F865DB1744A4F869BDF61DB3E4F25F0:::3F865DB1744A4F869BDF61DB3E4F25F0", "PolicyId": "6b17e76f-5fe4-462f-9f34-c724debc97cd", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "35840668-03be-44ba-b4a8-32eb1a3134f8", "PolicyName": "Test Policy", "LastInfected": "2025-02-28T18:37:13.7796561Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.234.217.163", "MACAddress": "BD-A7-9F-41-CC-50", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.146.177.244", "Deactivated": false, "LastScanSeq": "518699338", "ModifiedDate": "2025-05-23T18:37:13.7796561Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] }, { "Seq": 2, "EndpointId": "1f599dbd-8ec3-4800-94f9-cd86ddfc522a", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-07-30T18:37:13.7796561Z", "LastSeen": "2024-07-30T18:37:13.7796561Z", "AgentVersion": "9.0.13.58", "LicenseKey": "54E6-9F23-4E0B-4DF5-AF9B", "Expired": false, "LastChangesUserId": "3f243979-3d06-43a0-96b6-b0f1fa17b588", "MachineId": "B004EDA29DD94C718AC318FEF6993BC1:::0180B331AD5D49FAACBADD4EED2ED746:::0180B331AD5D49FAACBADD4EED2ED746", "PolicyId": "5a2a3eac-71f0-480f-9e56-c9a90a904427", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "737d0f0c-2a49-40f3-b25f-aaf07f9c4c2c", "PolicyName": "Test Policy", "LastInfected": "2024-11-30T18:37:13.7796561Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.64.127.210", "MACAddress": "8C-71-E6-52-E3-F1", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.207.185.235", "Deactivated": false, "LastScanSeq": "62780608", "ModifiedDate": "2025-05-16T18:37:13.7796561Z", "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>75cb030f-3d41-4337-95a7-2fccde295dd2</EndpointId> <Expired>false</Expired> <FirstSeen>2024-12-30T18:37:13.7796561Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>35840668-03be-44ba-b4a8-32eb1a3134f8</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.234.217.163</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>ad4af759-54ce-4109-95c0-04a0816ccc43</LastChangesUserId> <LastInfected>2025-02-28T18:37:13.7796561Z</LastInfected> <LastPublicIP>95.146.177.244</LastPublicIP> <LastScanSeq>518699338</LastScanSeq> <LastSeen>2024-12-30T18:37:13.7796561Z</LastSeen> <LicenseKey>54E6-9F23-4E0B-4DF5-AF9B</LicenseKey> <MACAddress>BD-A7-9F-41-CC-50</MACAddress> <Mac>false</Mac> <MachineId>A51294EB6627479AB01CB611CE3AC0C9:::3F865DB1744A4F869BDF61DB3E4F25F0:::3F865DB1744A4F869BDF61DB3E4F25F0</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-05-23T18:37:13.7796561Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>6b17e76f-5fe4-462f-9f34-c724debc97cd</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>1f599dbd-8ec3-4800-94f9-cd86ddfc522a</EndpointId> <Expired>false</Expired> <FirstSeen>2024-07-30T18:37:13.7796561Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>737d0f0c-2a49-40f3-b25f-aaf07f9c4c2c</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.64.127.210</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>3f243979-3d06-43a0-96b6-b0f1fa17b588</LastChangesUserId> <LastInfected>2024-11-30T18:37:13.7796561Z</LastInfected> <LastPublicIP>95.207.185.235</LastPublicIP> <LastScanSeq>62780608</LastScanSeq> <LastSeen>2024-07-30T18:37:13.7796561Z</LastSeen> <LicenseKey>54E6-9F23-4E0B-4DF5-AF9B</LicenseKey> <MACAddress>8C-71-E6-52-E3-F1</MACAddress> <Mac>false</Mac> <MachineId>B004EDA29DD94C718AC318FEF6993BC1:::0180B331AD5D49FAACBADD4EED2ED746:::0180B331AD5D49FAACBADD4EED2ED746</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-05-16T18:37:13.7796561Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>5a2a3eac-71f0-480f-9e56-c9a90a904427</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>