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": "1dc01ca8-805b-4f33-85a2-97f90ee4fe4d", "HostName": "MyComputer1", "GroupName": "Test Group", "FirstSeen": "2025-02-06T05:54:47.8720185Z", "LastSeen": "2025-02-06T05:54:47.8720185Z", "AgentVersion": "9.0.13.58", "LicenseKey": "4CEB-52AA-54D7-48F8-9B54", "Expired": false, "LastChangesUserId": "36f97e86-6c53-4e23-9a4c-4514a42e7a69", "MachineId": "30BBD54103BD4A2AB2C0AD3A594222A4:::5087FE7385D84DA7985A94BE224131D8:::5087FE7385D84DA7985A94BE224131D8", "PolicyId": "11ce01bf-6b32-48cd-8846-8055a835750e", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "10ae4a09-ec6e-4e66-851a-dd75ff129f18", "PolicyName": "Test Policy", "LastInfected": "2025-04-06T05:54:47.8720185Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 2, "InternalIP": "10.150.98.165", "MACAddress": "3F-A5-66-EB-0C-A0", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.84.67.234", "Deactivated": false, "LastScanSeq": "1432678029", "ModifiedDate": "2025-06-29T05:54:47.8720185Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] }, { "Seq": 2, "EndpointId": "ef917420-6920-4efa-9f40-b9685711d37e", "HostName": "MyComputer2", "GroupName": "Test Group", "FirstSeen": "2024-09-06T05:54:47.8720185Z", "LastSeen": "2024-09-06T05:54:47.8720185Z", "AgentVersion": "9.0.13.58", "LicenseKey": "4CEB-52AA-54D7-48F8-9B54", "Expired": false, "LastChangesUserId": "3e84aef0-6245-4948-8909-9a990652d26e", "MachineId": "DAB3A48F80BD4B1E84876524D76FB7E5:::593DDE401B044EE69B7BBB2CBE229FED:::593DDE401B044EE69B7BBB2CBE229FED", "PolicyId": "1d9c73ba-93c3-4288-a630-ef3c7e1221f3", "VM": false, "AgentLanguage": "en", "FriendlyPCName": "", "GroupId": "0095c871-f5d2-455c-bbee-1c71331bb23f", "PolicyName": "Test Policy", "LastInfected": "2025-01-06T05:54:47.8720185Z", "InfectedNow": false, "NumUsers": 1, "MaxUsers": 4, "InternalIP": "10.45.108.55", "MACAddress": "3C-54-61-96-0F-47", "ADDomain": "domain.webroot.com", "ADOU": "Webroot.Computers", "Workgroup": "WORKGROUP", "CurrentUser": "Paul", "Mac": false, "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit", "LastPublicIP": "95.66.119.169", "Deactivated": false, "LastScanSeq": "760966491", "ModifiedDate": "2025-06-22T05:54:47.8720185Z", "IsolationStatus": "UNISOLATED", "ActiveModules": [ "endpoint" ] } ] }
<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> <ActiveModules xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>endpoint</d4p1:string> </ActiveModules> <AgentLanguage>en</AgentLanguage> <AgentVersion>9.0.13.58</AgentVersion> <CurrentUser>Paul</CurrentUser> <Deactivated>false</Deactivated> <EndpointId>1dc01ca8-805b-4f33-85a2-97f90ee4fe4d</EndpointId> <Expired>false</Expired> <FirstSeen>2025-02-06T05:54:47.8720185Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>10ae4a09-ec6e-4e66-851a-dd75ff129f18</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer1</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.150.98.165</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>36f97e86-6c53-4e23-9a4c-4514a42e7a69</LastChangesUserId> <LastInfected>2025-04-06T05:54:47.8720185Z</LastInfected> <LastPublicIP>95.84.67.234</LastPublicIP> <LastScanSeq>1432678029</LastScanSeq> <LastSeen>2025-02-06T05:54:47.8720185Z</LastSeen> <LicenseKey>4CEB-52AA-54D7-48F8-9B54</LicenseKey> <MACAddress>3F-A5-66-EB-0C-A0</MACAddress> <Mac>false</Mac> <MachineId>30BBD54103BD4A2AB2C0AD3A594222A4:::5087FE7385D84DA7985A94BE224131D8:::5087FE7385D84DA7985A94BE224131D8</MachineId> <MaxUsers>2</MaxUsers> <ModifiedDate>2025-06-29T05:54:47.8720185Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>11ce01bf-6b32-48cd-8846-8055a835750e</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> <ActiveModules xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>endpoint</d4p1:string> </ActiveModules> <AgentLanguage>en</AgentLanguage> <AgentVersion>9.0.13.58</AgentVersion> <CurrentUser>Paul</CurrentUser> <Deactivated>false</Deactivated> <EndpointId>ef917420-6920-4efa-9f40-b9685711d37e</EndpointId> <Expired>false</Expired> <FirstSeen>2024-09-06T05:54:47.8720185Z</FirstSeen> <FriendlyPCName></FriendlyPCName> <GroupId>0095c871-f5d2-455c-bbee-1c71331bb23f</GroupId> <GroupName>Test Group</GroupName> <HostName>MyComputer2</HostName> <InfectedNow>false</InfectedNow> <InternalIP>10.45.108.55</InternalIP> <IsolationStatus>UNISOLATED</IsolationStatus> <LastChangesUserId>3e84aef0-6245-4948-8909-9a990652d26e</LastChangesUserId> <LastInfected>2025-01-06T05:54:47.8720185Z</LastInfected> <LastPublicIP>95.66.119.169</LastPublicIP> <LastScanSeq>760966491</LastScanSeq> <LastSeen>2024-09-06T05:54:47.8720185Z</LastSeen> <LicenseKey>4CEB-52AA-54D7-48F8-9B54</LicenseKey> <MACAddress>3C-54-61-96-0F-47</MACAddress> <Mac>false</Mac> <MachineId>DAB3A48F80BD4B1E84876524D76FB7E5:::593DDE401B044EE69B7BBB2CBE229FED:::593DDE401B044EE69B7BBB2CBE229FED</MachineId> <MaxUsers>4</MaxUsers> <ModifiedDate>2025-06-22T05:54:47.8720185Z</ModifiedDate> <NumUsers>1</NumUsers> <PolicyId>1d9c73ba-93c3-4288-a630-ef3c7e1221f3</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>