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": "a3f2c7a3-9f02-4cb8-8119-7e965bde9562",
"HostName": "MyComputer1",
"GroupName": "Test Group",
"FirstSeen": "2024-04-09T07:47:04.2043504Z",
"LastSeen": "2024-04-09T07:47:04.2043504Z",
"AgentVersion": "9.0.13.58",
"LicenseKey": "D9F9-F286-76B7-47FB-87C9",
"Expired": false,
"LastChangesUserId": "b6601378-3416-41df-a2ca-2ebdc5dec5ff",
"MachineId": "74ACB61BA5834D03B34F049E2A7F2B5C:::6BC408D97E15436BB8662DDC93E063FA:::6BC408D97E15436BB8662DDC93E063FA",
"PolicyId": "426d2128-329d-4aff-9b00-a614e3d86464",
"VM": false,
"AgentLanguage": "en",
"FriendlyPCName": "",
"GroupId": "075d60fe-712d-4486-844f-777f90d50a62",
"PolicyName": "Test Policy",
"LastInfected": "2024-06-09T07:47:04.2043504Z",
"InfectedNow": false,
"NumUsers": 1,
"MaxUsers": 2,
"InternalIP": "10.247.89.94",
"MACAddress": "40-8A-A6-F1-57-41",
"ADDomain": "domain.webroot.com",
"ADOU": "Webroot.Computers",
"Workgroup": "WORKGROUP",
"CurrentUser": "Paul",
"Mac": false,
"WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
"LastPublicIP": "95.62.125.226",
"Deactivated": false,
"LastScanSeq": "1791461141",
"ModifiedDate": "2024-09-02T07:47:04.2043504Z",
"IsolationStatus": "UNISOLATED"
},
{
"Seq": 2,
"EndpointId": "c018a8cd-c9da-4667-bbfe-4ffdea24b26c",
"HostName": "MyComputer2",
"GroupName": "Test Group",
"FirstSeen": "2023-11-09T07:47:04.2043504Z",
"LastSeen": "2023-11-09T07:47:04.2043504Z",
"AgentVersion": "9.0.13.58",
"LicenseKey": "D9F9-F286-76B7-47FB-87C9",
"Expired": false,
"LastChangesUserId": "a1d7e1d6-aaec-45e9-8631-7ef8d5ee4919",
"MachineId": "224355DBD4D1471984B976BCB6ACFA36:::24BD513348464390892FAEE013FAC695:::24BD513348464390892FAEE013FAC695",
"PolicyId": "e1c683d9-8e7f-4222-b79a-94ecdb54ca35",
"VM": false,
"AgentLanguage": "en",
"FriendlyPCName": "",
"GroupId": "f2255d5d-f809-427c-b89b-5be2f9b7c259",
"PolicyName": "Test Policy",
"LastInfected": "2024-03-09T07:47:04.2043504Z",
"InfectedNow": false,
"NumUsers": 1,
"MaxUsers": 4,
"InternalIP": "10.200.113.111",
"MACAddress": "46-04-EF-40-30-1E",
"ADDomain": "domain.webroot.com",
"ADOU": "Webroot.Computers",
"Workgroup": "WORKGROUP",
"CurrentUser": "Paul",
"Mac": false,
"WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
"LastPublicIP": "95.209.42.41",
"Deactivated": false,
"LastScanSeq": "160254824",
"ModifiedDate": "2024-08-26T07:47:04.2043504Z",
"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>a3f2c7a3-9f02-4cb8-8119-7e965bde9562</EndpointId>
<Expired>false</Expired>
<FirstSeen>2024-04-09T07:47:04.2043504Z</FirstSeen>
<FriendlyPCName></FriendlyPCName>
<GroupId>075d60fe-712d-4486-844f-777f90d50a62</GroupId>
<GroupName>Test Group</GroupName>
<HostName>MyComputer1</HostName>
<InfectedNow>false</InfectedNow>
<InternalIP>10.247.89.94</InternalIP>
<IsolationStatus>UNISOLATED</IsolationStatus>
<LastChangesUserId>b6601378-3416-41df-a2ca-2ebdc5dec5ff</LastChangesUserId>
<LastInfected>2024-06-09T07:47:04.2043504Z</LastInfected>
<LastPublicIP>95.62.125.226</LastPublicIP>
<LastScanSeq>1791461141</LastScanSeq>
<LastSeen>2024-04-09T07:47:04.2043504Z</LastSeen>
<LicenseKey>D9F9-F286-76B7-47FB-87C9</LicenseKey>
<MACAddress>40-8A-A6-F1-57-41</MACAddress>
<Mac>false</Mac>
<MachineId>74ACB61BA5834D03B34F049E2A7F2B5C:::6BC408D97E15436BB8662DDC93E063FA:::6BC408D97E15436BB8662DDC93E063FA</MachineId>
<MaxUsers>2</MaxUsers>
<ModifiedDate>2024-09-02T07:47:04.2043504Z</ModifiedDate>
<NumUsers>1</NumUsers>
<PolicyId>426d2128-329d-4aff-9b00-a614e3d86464</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>c018a8cd-c9da-4667-bbfe-4ffdea24b26c</EndpointId>
<Expired>false</Expired>
<FirstSeen>2023-11-09T07:47:04.2043504Z</FirstSeen>
<FriendlyPCName></FriendlyPCName>
<GroupId>f2255d5d-f809-427c-b89b-5be2f9b7c259</GroupId>
<GroupName>Test Group</GroupName>
<HostName>MyComputer2</HostName>
<InfectedNow>false</InfectedNow>
<InternalIP>10.200.113.111</InternalIP>
<IsolationStatus>UNISOLATED</IsolationStatus>
<LastChangesUserId>a1d7e1d6-aaec-45e9-8631-7ef8d5ee4919</LastChangesUserId>
<LastInfected>2024-03-09T07:47:04.2043504Z</LastInfected>
<LastPublicIP>95.209.42.41</LastPublicIP>
<LastScanSeq>160254824</LastScanSeq>
<LastSeen>2023-11-09T07:47:04.2043504Z</LastSeen>
<LicenseKey>D9F9-F286-76B7-47FB-87C9</LicenseKey>
<MACAddress>46-04-EF-40-30-1E</MACAddress>
<Mac>false</Mac>
<MachineId>224355DBD4D1471984B976BCB6ACFA36:::24BD513348464390892FAEE013FAC695:::24BD513348464390892FAEE013FAC695</MachineId>
<MaxUsers>4</MaxUsers>
<ModifiedDate>2024-08-26T07:47:04.2043504Z</ModifiedDate>
<NumUsers>1</NumUsers>
<PolicyId>e1c683d9-8e7f-4222-b79a-94ecdb54ca35</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>