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": "17ff233f-26fc-4ee8-9db1-59cf29a2a123", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2024-08-21T07:22:18.1649847Z", "LastSeen": "2024-08-21T07:22:18.1649847Z", "AgentVersion": "9.0.13.58", "LicenseKey": "543A-867E-0275-4E76-872D", "Expired": false, "LastChangesUserId": "ffc15a47-ac5f-4d22-b40c-6c828aad2b2d", "MachineId": "B484B2246D0B4B7B8C4D78247161CFA0:::2F33C5621B5146B3AA349906D52758A4:::2F33C5621B5146B3AA349906D52758A4", "PolicyId": "b704398a-89a2-4b1e-99b0-e24382ea85fa", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "ed7dd300-37e7-4cbe-8ffb-46d8c527d84d", "PolicyName": "Test Policy", "LastInfected": "2024-10-21T07:22:18.1649847Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.250.53.11", "MACAddress": "5A-93-F4-7A-92-77", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.82.151.82", "Deactivated": false, "LastScanSeq": "1083262494", "ModifiedDate": "2025-01-14T07:22:18.1649847Z", "IsolationStatus": "UNISOLATED" }, { "Seq": 2, "EndpointId": "eee1802e-aea6-4a2b-b068-4842f7bc365e", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-03-21T07:22:18.1649847Z", "LastSeen": "2024-03-21T07:22:18.1649847Z", "AgentVersion": "9.0.13.58", "LicenseKey": "543A-867E-0275-4E76-872D", "Expired": false, "LastChangesUserId": "9fa5d25d-a688-4604-b32d-f1f185bdf1be", "MachineId": "18E8DDEAC0B84AAE908D16E87F04F63A:::2C0E3F4FA4B34341855D1D4367276A77:::2C0E3F4FA4B34341855D1D4367276A77", "PolicyId": "5af1329f-7354-4fcc-8d85-e81d50dddaac", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "138a4b85-337c-47e3-8702-492460d1b002", "PolicyName": "Test Policy", "LastInfected": "2024-07-21T07:22:18.1649847Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.28.32.240", "MACAddress": "22-77-74-DD-00-FC", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.92.192.119", "Deactivated": false, "LastScanSeq": "455441821", "ModifiedDate": "2025-01-07T07:22:18.1649847Z", "IsolationStatus": "UNISOLATED" } ] }
<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> <AgentLanguage>en</AgentLanguage> <AgentVersion>9.0.13.58</AgentVersion> <CurrentUser>Paul</CurrentUser> <Deactivated>false</Deactivated> <EndpointId>17ff233f-26fc-4ee8-9db1-59cf29a2a123</EndpointId> <Expired>false</Expired> <FirstSeen>2024-08-21T07:22:18.1649847Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>ed7dd300-37e7-4cbe-8ffb-46d8c527d84d</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.250.53.11</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>ffc15a47-ac5f-4d22-b40c-6c828aad2b2d</LastChangesUserId> <LastInfected>2024-10-21T07:22:18.1649847Z</LastInfected> <LastPublicIP>95.82.151.82</LastPublicIP> <LastScanSeq>1083262494</LastScanSeq> <LastSeen>2024-08-21T07:22:18.1649847Z</LastSeen> <LicenseKey>543A-867E-0275-4E76-872D</LicenseKey> <MACAddress>5A-93-F4-7A-92-77</MACAddress> <Mac>false</Mac> <MachineId>B484B2246D0B4B7B8C4D78247161CFA0:::2F33C5621B5146B3AA349906D52758A4:::2F33C5621B5146B3AA349906D52758A4</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-01-14T07:22:18.1649847Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>b704398a-89a2-4b1e-99b0-e24382ea85fa</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> <AgentLanguage>en</AgentLanguage> <AgentVersion>9.0.13.58</AgentVersion> <CurrentUser>Paul</CurrentUser> <Deactivated>false</Deactivated> <EndpointId>eee1802e-aea6-4a2b-b068-4842f7bc365e</EndpointId> <Expired>false</Expired> <FirstSeen>2024-03-21T07:22:18.1649847Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>138a4b85-337c-47e3-8702-492460d1b002</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.28.32.240</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>9fa5d25d-a688-4604-b32d-f1f185bdf1be</LastChangesUserId> <LastInfected>2024-07-21T07:22:18.1649847Z</LastInfected> <LastPublicIP>95.92.192.119</LastPublicIP> <LastScanSeq>455441821</LastScanSeq> <LastSeen>2024-03-21T07:22:18.1649847Z</LastSeen> <LicenseKey>543A-867E-0275-4E76-872D</LicenseKey> <MACAddress>22-77-74-DD-00-FC</MACAddress> <Mac>false</Mac> <MachineId>18E8DDEAC0B84AAE908D16E87F04F63A:::2C0E3F4FA4B34341855D1D4367276A77:::2C0E3F4FA4B34341855D1D4367276A77</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-01-07T07:22:18.1649847Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>5af1329f-7354-4fcc-8d85-e81d50dddaac</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>