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": "9c81f545-2cbe-481a-956c-d7421b3d3d71", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2022-09-08T21:28:18.1158492Z", "LastSeen": "2022-09-08T21:28:18.1158492Z", "AgentVersion": "9.0.13.58", "LicenseKey": "B6AE-CDE3-01E1-493B-9821", "Expired": false, "LastChangesUserId": "b30f76c7-5601-46cb-998b-b66ed3d6ea85", "MachineId": "90CA3C4456DE4A079F205D8FE48560F1:::8A044A6E0F9346BABFE0DEFE2ACA82D5:::8A044A6E0F9346BABFE0DEFE2ACA82D5", "PolicyId": "aebcb58c-7661-44f9-9da0-1b24f0166eaa", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "a9dac30a-c776-4126-bbf2-b208b1c34fde", "PolicyName": "Test Policy", "LastInfected": "2022-11-08T21:28:18.1158492Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.103.48.237", "MACAddress": "B8-35-4F-84-83-BE", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.30.52.223", "Deactivated": false, "LastScanSeq": "1699065422", "ModifiedDate": "2023-02-01T21:28:18.1158492Z" }, { "Seq": 2, "EndpointId": "56400153-7cc4-4612-b4b2-9626d97a2e58", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2022-04-08T21:28:18.1158492Z", "LastSeen": "2022-04-08T21:28:18.1158492Z", "AgentVersion": "9.0.13.58", "LicenseKey": "B6AE-CDE3-01E1-493B-9821", "Expired": false, "LastChangesUserId": "6bae4d24-27ef-4d14-b847-9c1223f59619", "MachineId": "5E1B85C2B39D42849D1F087C0FB5BEEF:::69BD1380E1144FA1B9AF190FB403C1E0:::69BD1380E1144FA1B9AF190FB403C1E0", "PolicyId": "35c0c8a6-80bc-4560-a548-b04c2c57da11", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "edcfc7b1-5d50-412d-aa64-f754a57f7872", "PolicyName": "Test Policy", "LastInfected": "2022-08-08T21:28:18.1158492Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.116.89.236", "MACAddress": "05-F1-78-BB-36-BE", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.17.53.198", "Deactivated": false, "LastScanSeq": "107579270", "ModifiedDate": "2023-01-25T21:28:18.1158492Z" } ] }
<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>9c81f545-2cbe-481a-956c-d7421b3d3d71</EndpointId> <Expired>false</Expired> <FirstSeen>2022-09-08T21:28:18.1158492Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>a9dac30a-c776-4126-bbf2-b208b1c34fde</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.103.48.237</InternalIP> <LastChangesUserId>b30f76c7-5601-46cb-998b-b66ed3d6ea85</LastChangesUserId> <LastInfected>2022-11-08T21:28:18.1158492Z</LastInfected> <LastPublicIP>95.30.52.223</LastPublicIP> <LastScanSeq>1699065422</LastScanSeq> <LastSeen>2022-09-08T21:28:18.1158492Z</LastSeen> <LicenseKey>B6AE-CDE3-01E1-493B-9821</LicenseKey> <MACAddress>B8-35-4F-84-83-BE</MACAddress> <Mac>false</Mac> <MachineId>90CA3C4456DE4A079F205D8FE48560F1:::8A044A6E0F9346BABFE0DEFE2ACA82D5:::8A044A6E0F9346BABFE0DEFE2ACA82D5</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2023-02-01T21:28:18.1158492Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>aebcb58c-7661-44f9-9da0-1b24f0166eaa</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>56400153-7cc4-4612-b4b2-9626d97a2e58</EndpointId> <Expired>false</Expired> <FirstSeen>2022-04-08T21:28:18.1158492Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>edcfc7b1-5d50-412d-aa64-f754a57f7872</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.116.89.236</InternalIP> <LastChangesUserId>6bae4d24-27ef-4d14-b847-9c1223f59619</LastChangesUserId> <LastInfected>2022-08-08T21:28:18.1158492Z</LastInfected> <LastPublicIP>95.17.53.198</LastPublicIP> <LastScanSeq>107579270</LastScanSeq> <LastSeen>2022-04-08T21:28:18.1158492Z</LastSeen> <LicenseKey>B6AE-CDE3-01E1-493B-9821</LicenseKey> <MACAddress>05-F1-78-BB-36-BE</MACAddress> <Mac>false</Mac> <MachineId>5E1B85C2B39D42849D1F087C0FB5BEEF:::69BD1380E1144FA1B9AF190FB403C1E0:::69BD1380E1144FA1B9AF190FB403C1E0</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2023-01-25T21:28:18.1158492Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>35c0c8a6-80bc-4560-a548-b04c2c57da11</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>