GET /service/api/console/gsm/{gsmKey}/sites/{siteId}/endpoints
?type={type}
&hostName={hostName}
&machineId={machineId}
&order={order}
&orderDirection={orderDirection}
&pageSize={pageSize}
&pageNr={pageNr}
Gets the list of endpoints on a given GSM site.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
gsmKey |
The GSM console keycode. |
string |
Required |
siteId |
The site identifier. |
string |
Required |
type |
Can be set to "active" (returns active endpoints only) or "deactivated" (returns deactivated endpoints only). If this parameter is omitted, endpoints regardless of their activation state are returned. |
string |
None. |
hostName |
Used to search for a particular hostname. |
string |
None. |
machineId |
Used to search for a particular machine. |
string |
None. |
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/endpoints
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?type=active
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?hostName=MyComputer1
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?machineId=e12cee848565435b8533ec7540366f13:::9a3ff75d83634d1386af15c238b575fb:::9a3ff75d83634d1386af15c238b575fb
|
GET
|
https://unityapi.webrootcloudav.com/service/api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/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/endpoints?order=lastseen&orderDirection=A
|
Body Parameters
None.
Response Information
Resource Description
Information about the list of endpoints on a given GSM site.
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": "d5bd8403-f505-418a-be29-278633c220f8", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2023-11-25T10:27:36.4580229Z", "LastSeen": "2023-11-25T10:27:36.4580229Z", "AgentVersion": "9.0.13.58", "LicenseKey": "AE3C-5CF5-D604-430F-AD2F", "Expired": false, "LastChangesUserId": "d0d8ae35-37cc-4fc5-9cdd-c280118a176d", "MachineId": "30E933D1F54640B69D3CC2DC3BBA4FB5:::85899A8B92B445EEBB2AC958B1CB24F1:::85899A8B92B445EEBB2AC958B1CB24F1", "PolicyId": "7b5530bc-07e7-4422-afa8-7f12dcb08bc3", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "436b006f-76c7-4e05-9921-963dea57435d", "PolicyName": "Test Policy", "LastInfected": "2024-01-25T10:27:36.4580229Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.227.136.44", "MACAddress": "51-69-BE-31-58-5C", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.136.123.4", "Deactivated": false, "LastScanSeq": "1559310495", "ModifiedDate": "2024-04-18T10:27:36.4580229Z" }, { "Seq": 2, "EndpointId": "aac64b11-49d3-451a-8917-db6e823b172c", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2023-06-25T10:27:36.4580229Z", "LastSeen": "2023-06-25T10:27:36.4580229Z", "AgentVersion": "9.0.13.58", "LicenseKey": "AE3C-5CF5-D604-430F-AD2F", "Expired": false, "LastChangesUserId": "6c62c842-732f-491d-af71-5e1457be2d33", "MachineId": "3F36306D0A564898AF0F4C3CB9A919D7:::03CBDFE7F58F45FB99AFBF4F83403357:::03CBDFE7F58F45FB99AFBF4F83403357", "PolicyId": "6517bce9-5354-4bd1-a884-f5109b6c2820", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "c763667d-9c17-48ba-ac86-7f80cb70aead", "PolicyName": "Test Policy", "LastInfected": "2023-10-25T10:27:36.4580229Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.124.181.165", "MACAddress": "7E-3C-EC-9C-2D-F7", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.204.98.70", "Deactivated": false, "LastScanSeq": "309918093", "ModifiedDate": "2024-04-11T10:27:36.4580229Z" } ] }
<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>d5bd8403-f505-418a-be29-278633c220f8</EndpointId> <Expired>false</Expired> <FirstSeen>2023-11-25T10:27:36.4580229Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>436b006f-76c7-4e05-9921-963dea57435d</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.227.136.44</InternalIP> <LastChangesUserId>d0d8ae35-37cc-4fc5-9cdd-c280118a176d</LastChangesUserId> <LastInfected>2024-01-25T10:27:36.4580229Z</LastInfected> <LastPublicIP>95.136.123.4</LastPublicIP> <LastScanSeq>1559310495</LastScanSeq> <LastSeen>2023-11-25T10:27:36.4580229Z</LastSeen> <LicenseKey>AE3C-5CF5-D604-430F-AD2F</LicenseKey> <MACAddress>51-69-BE-31-58-5C</MACAddress> <Mac>false</Mac> <MachineId>30E933D1F54640B69D3CC2DC3BBA4FB5:::85899A8B92B445EEBB2AC958B1CB24F1:::85899A8B92B445EEBB2AC958B1CB24F1</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2024-04-18T10:27:36.4580229Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>7b5530bc-07e7-4422-afa8-7f12dcb08bc3</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>aac64b11-49d3-451a-8917-db6e823b172c</EndpointId> <Expired>false</Expired> <FirstSeen>2023-06-25T10:27:36.4580229Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>c763667d-9c17-48ba-ac86-7f80cb70aead</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.124.181.165</InternalIP> <LastChangesUserId>6c62c842-732f-491d-af71-5e1457be2d33</LastChangesUserId> <LastInfected>2023-10-25T10:27:36.4580229Z</LastInfected> <LastPublicIP>95.204.98.70</LastPublicIP> <LastScanSeq>309918093</LastScanSeq> <LastSeen>2023-06-25T10:27:36.4580229Z</LastSeen> <LicenseKey>AE3C-5CF5-D604-430F-AD2F</LicenseKey> <MACAddress>7E-3C-EC-9C-2D-F7</MACAddress> <Mac>false</Mac> <MachineId>3F36306D0A564898AF0F4C3CB9A919D7:::03CBDFE7F58F45FB99AFBF4F83403357:::03CBDFE7F58F45FB99AFBF4F83403357</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2024-04-11T10:27:36.4580229Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>6517bce9-5354-4bd1-a884-f5109b6c2820</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>