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.
GetEndpointsResponseModel| Name | 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": "b5bceeeb-f312-4cbe-9332-90371fe2323c",
"HostName": "MyComputer1",
"GroupName": "Test Group",
"FirstSeen": "2023-11-20T04:03:40.1051968Z",
"LastSeen": "2023-11-20T04:03:40.1051968Z",
"AgentVersion": "9.0.13.58",
"LicenseKey": "8429-0BBE-D694-4F2C-8058",
"Expired": false,
"LastChangesUserId": "1a619d39-7bf6-4507-9e1b-682d27e25cc7",
"MachineId": "7D25BF7291944BF890887D9D3C2E61D0:::304B3E88D77A416FB5494BB2100CCAA5:::304B3E88D77A416FB5494BB2100CCAA5",
"PolicyId": "c05a0e96-f064-46e8-b553-1de5e97a970a",
"VM": false,
"AgentLanguage": "en",
"FriendlyPCName": "",
"GroupId": "ac2a32a7-dd37-410a-9694-2997c926e836",
"PolicyName": "Test Policy",
"LastInfected": "2024-01-20T04:03:40.1051968Z",
"InfectedNow": false,
"NumUsers": 1,
"MaxUsers": 2,
"InternalIP": "10.182.205.241",
"MACAddress": "57-C4-BA-56-6D-39",
"ADDomain": "domain.webroot.com",
"ADOU": "Webroot.Computers",
"Workgroup": "WORKGROUP",
"CurrentUser": "Paul",
"Mac": false,
"WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
"LastPublicIP": "95.188.52.2",
"Deactivated": false,
"LastScanSeq": "1964811293",
"ModifiedDate": "2024-04-13T04:03:40.1051968Z"
},
{
"Seq": 2,
"EndpointId": "487ea2ba-939b-4fd8-a9f1-275b8f6a3fd7",
"HostName": "MyComputer2",
"GroupName": "Test Group",
"FirstSeen": "2023-06-20T04:03:40.1051968Z",
"LastSeen": "2023-06-20T04:03:40.1051968Z",
"AgentVersion": "9.0.13.58",
"LicenseKey": "8429-0BBE-D694-4F2C-8058",
"Expired": false,
"LastChangesUserId": "907afaae-e574-43bd-9d6f-e8106d3be18a",
"MachineId": "9C5FF67E391D4BE48A819811CBDDD7B6:::F1ECA26FEDCA4A8D87E567C8BBE74092:::F1ECA26FEDCA4A8D87E567C8BBE74092",
"PolicyId": "a76051bd-8a6f-4974-b13f-7b6018973f93",
"VM": false,
"AgentLanguage": "en",
"FriendlyPCName": "",
"GroupId": "183b3768-aace-4152-8036-4bdc2797c0c5",
"PolicyName": "Test Policy",
"LastInfected": "2023-10-20T04:03:40.1051968Z",
"InfectedNow": false,
"NumUsers": 1,
"MaxUsers": 4,
"InternalIP": "10.235.33.185",
"MACAddress": "58-25-29-31-DF-CE",
"ADDomain": "domain.webroot.com",
"ADOU": "Webroot.Computers",
"Workgroup": "WORKGROUP",
"CurrentUser": "Paul",
"Mac": false,
"WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
"LastPublicIP": "95.49.79.249",
"Deactivated": false,
"LastScanSeq": "869745230",
"ModifiedDate": "2024-04-06T04:03:40.1051968Z"
}
]
}
<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>b5bceeeb-f312-4cbe-9332-90371fe2323c</EndpointId>
<Expired>false</Expired>
<FirstSeen>2023-11-20T04:03:40.1051968Z</FirstSeen>
<FriendlyPCName></FriendlyPCName>
<GroupId>ac2a32a7-dd37-410a-9694-2997c926e836</GroupId>
<GroupName>Test Group</GroupName>
<HostName>MyComputer1</HostName>
<InfectedNow>false</InfectedNow>
<InternalIP>10.182.205.241</InternalIP>
<LastChangesUserId>1a619d39-7bf6-4507-9e1b-682d27e25cc7</LastChangesUserId>
<LastInfected>2024-01-20T04:03:40.1051968Z</LastInfected>
<LastPublicIP>95.188.52.2</LastPublicIP>
<LastScanSeq>1964811293</LastScanSeq>
<LastSeen>2023-11-20T04:03:40.1051968Z</LastSeen>
<LicenseKey>8429-0BBE-D694-4F2C-8058</LicenseKey>
<MACAddress>57-C4-BA-56-6D-39</MACAddress>
<Mac>false</Mac>
<MachineId>7D25BF7291944BF890887D9D3C2E61D0:::304B3E88D77A416FB5494BB2100CCAA5:::304B3E88D77A416FB5494BB2100CCAA5</MachineId>
<MaxUsers>2</MaxUsers>
<ModifiedDate>2024-04-13T04:03:40.1051968Z</ModifiedDate>
<NumUsers>1</NumUsers>
<PolicyId>c05a0e96-f064-46e8-b553-1de5e97a970a</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>487ea2ba-939b-4fd8-a9f1-275b8f6a3fd7</EndpointId>
<Expired>false</Expired>
<FirstSeen>2023-06-20T04:03:40.1051968Z</FirstSeen>
<FriendlyPCName></FriendlyPCName>
<GroupId>183b3768-aace-4152-8036-4bdc2797c0c5</GroupId>
<GroupName>Test Group</GroupName>
<HostName>MyComputer2</HostName>
<InfectedNow>false</InfectedNow>
<InternalIP>10.235.33.185</InternalIP>
<LastChangesUserId>907afaae-e574-43bd-9d6f-e8106d3be18a</LastChangesUserId>
<LastInfected>2023-10-20T04:03:40.1051968Z</LastInfected>
<LastPublicIP>95.49.79.249</LastPublicIP>
<LastScanSeq>869745230</LastScanSeq>
<LastSeen>2023-06-20T04:03:40.1051968Z</LastSeen>
<LicenseKey>8429-0BBE-D694-4F2C-8058</LicenseKey>
<MACAddress>58-25-29-31-DF-CE</MACAddress>
<Mac>false</Mac>
<MachineId>9C5FF67E391D4BE48A819811CBDDD7B6:::F1ECA26FEDCA4A8D87E567C8BBE74092:::F1ECA26FEDCA4A8D87E567C8BBE74092</MachineId>
<MaxUsers>4</MaxUsers>
<ModifiedDate>2024-04-06T04:03:40.1051968Z</ModifiedDate>
<NumUsers>1</NumUsers>
<PolicyId>a76051bd-8a6f-4974-b13f-7b6018973f93</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>