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": "a14ef244-94e7-48bb-9670-34145153677f", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2024-02-27T01:35:27.9991446Z", "LastSeen": "2024-02-27T01:35:27.9991446Z", "AgentVersion": "9.0.13.58", "LicenseKey": "4780-D9D1-37A7-4A94-8363", "Expired": false, "LastChangesUserId": "25933f2a-dcd9-4a71-acb9-40b3a656d99a", "MachineId": "E778B173CE7C4F64A3B8F9216569D414:::89933541E2384CCAA01565621AC5EDA3:::89933541E2384CCAA01565621AC5EDA3", "PolicyId": "aee4f84b-f6c1-490b-a7bb-06776e9d2d8e", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "15ab0b23-847c-4bc2-8cb3-681450caced3", "PolicyName": "Test Policy", "LastInfected": "2024-04-27T01:35:27.9991446Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.37.182.151", "MACAddress": "A1-FA-E6-71-A0-1B", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.226.162.151", "Deactivated": false, "LastScanSeq": "807705909", "ModifiedDate": "2024-07-20T01:35:27.9991446Z" }, { "Seq": 2, "EndpointId": "ff0ce6fc-77a9-4098-85b4-906072e08896", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2023-09-27T01:35:27.9991446Z", "LastSeen": "2023-09-27T01:35:27.9991446Z", "AgentVersion": "9.0.13.58", "LicenseKey": "4780-D9D1-37A7-4A94-8363", "Expired": false, "LastChangesUserId": "5713f839-0b4a-43ba-b854-f27c6d71ea77", "MachineId": "C0F9041B12BC4288ADB80FB55BCF8E8F:::D75C5B7EF8384C9E8FC0BF7A0D91F424:::D75C5B7EF8384C9E8FC0BF7A0D91F424", "PolicyId": "5184a182-e6a4-4693-9125-4176613c694f", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "1a6aa843-c27f-4018-8cb3-fb1ea4bbf659", "PolicyName": "Test Policy", "LastInfected": "2024-01-27T01:35:27.9991446Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.186.48.207", "MACAddress": "C6-81-D6-1F-C8-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.9.42.70", "Deactivated": false, "LastScanSeq": "1320194396", "ModifiedDate": "2024-07-13T01:35:27.9991446Z" } ] }
<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>a14ef244-94e7-48bb-9670-34145153677f</EndpointId> <Expired>false</Expired> <FirstSeen>2024-02-27T01:35:27.9991446Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>15ab0b23-847c-4bc2-8cb3-681450caced3</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.37.182.151</InternalIP> <LastChangesUserId>25933f2a-dcd9-4a71-acb9-40b3a656d99a</LastChangesUserId> <LastInfected>2024-04-27T01:35:27.9991446Z</LastInfected> <LastPublicIP>95.226.162.151</LastPublicIP> <LastScanSeq>807705909</LastScanSeq> <LastSeen>2024-02-27T01:35:27.9991446Z</LastSeen> <LicenseKey>4780-D9D1-37A7-4A94-8363</LicenseKey> <MACAddress>A1-FA-E6-71-A0-1B</MACAddress> <Mac>false</Mac> <MachineId>E778B173CE7C4F64A3B8F9216569D414:::89933541E2384CCAA01565621AC5EDA3:::89933541E2384CCAA01565621AC5EDA3</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2024-07-20T01:35:27.9991446Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>aee4f84b-f6c1-490b-a7bb-06776e9d2d8e</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>ff0ce6fc-77a9-4098-85b4-906072e08896</EndpointId> <Expired>false</Expired> <FirstSeen>2023-09-27T01:35:27.9991446Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>1a6aa843-c27f-4018-8cb3-fb1ea4bbf659</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.186.48.207</InternalIP> <LastChangesUserId>5713f839-0b4a-43ba-b854-f27c6d71ea77</LastChangesUserId> <LastInfected>2024-01-27T01:35:27.9991446Z</LastInfected> <LastPublicIP>95.9.42.70</LastPublicIP> <LastScanSeq>1320194396</LastScanSeq> <LastSeen>2023-09-27T01:35:27.9991446Z</LastSeen> <LicenseKey>4780-D9D1-37A7-4A94-8363</LicenseKey> <MACAddress>C6-81-D6-1F-C8-AC</MACAddress> <Mac>false</Mac> <MachineId>C0F9041B12BC4288ADB80FB55BCF8E8F:::D75C5B7EF8384C9E8FC0BF7A0D91F424:::D75C5B7EF8384C9E8FC0BF7A0D91F424</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2024-07-13T01:35:27.9991446Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>5184a182-e6a4-4693-9125-4176613c694f</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>