Unity API Documentation

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

NameDescriptionTypeAdditional 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. Default value is "A".

 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
api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints
GET
api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?type=active
GET
api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?hostName=MyComputer1
GET
api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?machineId=e12cee848565435b8533ec7540366f13:::9a3ff75d83634d1386af15c238b575fb:::9a3ff75d83634d1386af15c238b575fb
GET
api/console/gsm/3515-3EC8-3018-4DAB-A776/sites/3c5b599c-f244-4c7e-a78b-b3e9f252fac8/endpoints?pageSize=100&pageNr=3
GET
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.

GetEndpointsResponseModel
NameDescriptionTypeAdditional 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": "f74735a4-98d1-402b-8e1a-85f7b5f1cf67",
      "HostName": "MyComputer1",
      "GroupName": "Test Group",
      "FirstSeen": "2019-09-25T08:34:11.9718972Z",
      "LastSeen": "2019-09-25T08:34:11.9718972Z",
      "AgentVersion": "9.0.13.58",
      "LicenseKey": "9C7A-4401-D060-4F1F-B82E",
      "Expired": false,
      "LastChangesUserId": "655cb8ad-bf66-45ad-9ab1-f979ee585d6d",
      "MachineId": "492C207DD91841AB865056060F5C0258:::F90E67A1799D4721BA3AFB4B090F8508:::F90E67A1799D4721BA3AFB4B090F8508",
      "PolicyId": "cadabfd9-7659-4f77-a634-94784eef792c",
      "VM": false,
      "AgentLanguage": "en",
      "FriendlyPCName": "",
      "GroupId": "e88e1e54-dd75-478e-a0d3-372c8151071c",
      "PolicyName": "Test Policy",
      "LastInfected": "2019-11-25T08:34:11.9718972Z",
      "InfectedNow": false,
      "NumUsers": 1,
      "MaxUsers": 2,
      "InternalIP": "10.163.124.49",
      "MACAddress": "A7-71-A7-71-1E-3D",
      "ADDomain": "domain.webroot.com",
      "ADOU": "Webroot.Computers",
      "Workgroup": "WORKGROUP",
      "CurrentUser": "Paul",
      "Mac": false,
      "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
      "LastPublicIP": "95.61.129.148",
      "Deactivated": false,
      "LastScanSeq": "491846978",
      "ModifiedDate": "2020-02-18T08:34:11.9718972Z"
    },
    {
      "Seq": 2,
      "EndpointId": "2f7dcec0-862e-4fda-a779-0c44e86449ae",
      "HostName": "MyComputer2",
      "GroupName": "Test Group",
      "FirstSeen": "2019-04-25T08:34:11.9718972Z",
      "LastSeen": "2019-04-25T08:34:11.9718972Z",
      "AgentVersion": "9.0.13.58",
      "LicenseKey": "9C7A-4401-D060-4F1F-B82E",
      "Expired": false,
      "LastChangesUserId": "9d4b4ce7-7737-4907-bb14-90f583333ff0",
      "MachineId": "717EB4BEE09041978316CA936DE6FEA3:::0A6F15DBAABF4E9FB2957A9B203C4BB0:::0A6F15DBAABF4E9FB2957A9B203C4BB0",
      "PolicyId": "50087f30-de52-4de0-aac8-caddd8a7570d",
      "VM": false,
      "AgentLanguage": "en",
      "FriendlyPCName": "",
      "GroupId": "ba0a7689-b2f3-4a00-9762-39cea671f9dd",
      "PolicyName": "Test Policy",
      "LastInfected": "2019-08-25T08:34:11.9718972Z",
      "InfectedNow": false,
      "NumUsers": 1,
      "MaxUsers": 4,
      "InternalIP": "10.166.19.146",
      "MACAddress": "D4-DA-69-05-9D-22",
      "ADDomain": "domain.webroot.com",
      "ADOU": "Webroot.Computers",
      "Workgroup": "WORKGROUP",
      "CurrentUser": "Paul",
      "Mac": false,
      "WindowsFullOS": "Windows 7 Service Pack 1 (Build 7601) 64bit",
      "LastPublicIP": "95.15.229.244",
      "Deactivated": false,
      "LastScanSeq": "1289219675",
      "ModifiedDate": "2020-02-11T08:34:11.9718972Z"
    }
  ]
}                    
<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>f74735a4-98d1-402b-8e1a-85f7b5f1cf67</EndpointId>
      <Expired>false</Expired>
      <FirstSeen>2019-09-25T08:34:11.9718972Z</FirstSeen>
      <FriendlyPCName></FriendlyPCName>
      <GroupId>e88e1e54-dd75-478e-a0d3-372c8151071c</GroupId>
      <GroupName>Test Group</GroupName>
      <HostName>MyComputer1</HostName>
      <InfectedNow>false</InfectedNow>
      <InternalIP>10.163.124.49</InternalIP>
      <LastChangesUserId>655cb8ad-bf66-45ad-9ab1-f979ee585d6d</LastChangesUserId>
      <LastInfected>2019-11-25T08:34:11.9718972Z</LastInfected>
      <LastPublicIP>95.61.129.148</LastPublicIP>
      <LastScanSeq>491846978</LastScanSeq>
      <LastSeen>2019-09-25T08:34:11.9718972Z</LastSeen>
      <LicenseKey>9C7A-4401-D060-4F1F-B82E</LicenseKey>
      <MACAddress>A7-71-A7-71-1E-3D</MACAddress>
      <Mac>false</Mac>
      <MachineId>492C207DD91841AB865056060F5C0258:::F90E67A1799D4721BA3AFB4B090F8508:::F90E67A1799D4721BA3AFB4B090F8508</MachineId>
      <MaxUsers>2</MaxUsers>
      <ModifiedDate>2020-02-18T08:34:11.9718972Z</ModifiedDate>
      <NumUsers>1</NumUsers>
      <PolicyId>cadabfd9-7659-4f77-a634-94784eef792c</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>2f7dcec0-862e-4fda-a779-0c44e86449ae</EndpointId>
      <Expired>false</Expired>
      <FirstSeen>2019-04-25T08:34:11.9718972Z</FirstSeen>
      <FriendlyPCName></FriendlyPCName>
      <GroupId>ba0a7689-b2f3-4a00-9762-39cea671f9dd</GroupId>
      <GroupName>Test Group</GroupName>
      <HostName>MyComputer2</HostName>
      <InfectedNow>false</InfectedNow>
      <InternalIP>10.166.19.146</InternalIP>
      <LastChangesUserId>9d4b4ce7-7737-4907-bb14-90f583333ff0</LastChangesUserId>
      <LastInfected>2019-08-25T08:34:11.9718972Z</LastInfected>
      <LastPublicIP>95.15.229.244</LastPublicIP>
      <LastScanSeq>1289219675</LastScanSeq>
      <LastSeen>2019-04-25T08:34:11.9718972Z</LastSeen>
      <LicenseKey>9C7A-4401-D060-4F1F-B82E</LicenseKey>
      <MACAddress>D4-DA-69-05-9D-22</MACAddress>
      <Mac>false</Mac>
      <MachineId>717EB4BEE09041978316CA936DE6FEA3:::0A6F15DBAABF4E9FB2957A9B203C4BB0:::0A6F15DBAABF4E9FB2957A9B203C4BB0</MachineId>
      <MaxUsers>4</MaxUsers>
      <ModifiedDate>2020-02-11T08:34:11.9718972Z</ModifiedDate>
      <NumUsers>1</NumUsers>
      <PolicyId>50087f30-de52-4de0-aac8-caddd8a7570d</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>