Gets the list of endpoints on a given GSM site.
GET {{baseUrl}}/api/console/gsm/:gsmKey/sites/:siteId/endpoints?type=deactivated&hostName=MyComputer1&machineId=CD0E0775E3794700A00025BA95D6E760:::E05A6E55EF2B4376A709B3B465DF4462:::E05A6E55EF2B4376A709B3B465DF4462&order=hostname&orderDirection=A&pageSize=50&pageNr=1
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
type | string | 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. | |
hostName | string | Used to search for a particular hostname. | |
machineId | string | Used to search for a particular machine. | |
order | string | Used to determine the order field. Valid values are "hostname", "firstseen", "lastseen", "agentversion", "lastinfected". Default value is "hostname". | |
orderDirection | string | 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. | |
pageSize | number | Specifies the number of records being returned. | |
pageNr | number | Specifies the page number. Can be used to retrieve the next batch of records. Default value is 1. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"TotalAvailable":2,"PageNr":1,"PageSize":50,"Endpoints":[{"Seq":1,"EndpointId":"74c011fb-4d17-495e-a55b-19090605e3b4","HostName":"MyComputer1","GroupName":"Test Group","FirstSeen":"2022-06-29T10:36:03.9191928Z","LastSeen":"2022-06-29T10:36:03.9191928Z","AgentVersion":"9.0.13.58","LicenseKey":"A43E-9B1B-5D63-4091-888E","Expired":false,"LastChangesUserId":"99225430-7a71-473e-ae1a-a706caf62509","MachineId":"C47139E8F15B46DDA141DD2E6C237C3F:::2FE4D539E6254A2D94084A90F19F46E6:::2FE4D539E6254A2D94084A90F19F46E6","PolicyId":"3dd76e29-1844-4d92-a0b4-95525cc8d1ce","VM":false,"AgentLanguage":"en","FriendlyPCName":"","GroupId":"8ca2b6ca-ef2d-4b76-8d4e-60357605e40c","PolicyName":"Test Policy","LastInfected":"2022-08-29T10:36:03.9191928Z","InfectedNow":false,"NumUsers":1,"MaxUsers":2,"InternalIP":"10.32.95.93","MACAddress":"51-44-BB-BA-AC-8A","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.28.6","Deactivated":false,"LastScanSeq":"478900162","ModifiedDate":"2022-11-22T10:36:03.9191928Z"},{"Seq":2,"EndpointId":"a096c6ac-495d-4a81-99c2-c011130637a5","HostName":"MyComputer2","GroupName":"Test Group","FirstSeen":"2022-01-29T10:36:03.9191928Z","LastSeen":"2022-01-29T10:36:03.9191928Z","AgentVersion":"9.0.13.58","LicenseKey":"A43E-9B1B-5D63-4091-888E","Expired":false,"LastChangesUserId":"1b60e8f9-f956-42b5-92e3-79340b0e69cc","MachineId":"B544B6F3BAE94691A3FDD2A352C35A6F:::1D7CB383D41F4646BB5F7CDB0E738CC7:::1D7CB383D41F4646BB5F7CDB0E738CC7","PolicyId":"f60b69a7-eaaa-4bcc-9b38-40f1782a0607","VM":false,"AgentLanguage":"en","FriendlyPCName":"","GroupId":"62eca38e-5048-482a-b27b-77bf142ae800","PolicyName":"Test Policy","LastInfected":"2022-05-29T10:36:03.9191928Z","InfectedNow":false,"NumUsers":1,"MaxUsers":4,"InternalIP":"10.70.112.140","MACAddress":"C1-F1-22-2A-52-AE","ADDomain":"domain.webroot.com","ADOU":"Webroot.Computers","Workgroup":"WORKGROUP","CurrentUser":"Paul","Mac":false,"WindowsFullOS":"Windows 7 Service Pack 1 (Build 7601) 64bit","LastPublicIP":"95.56.139.163","Deactivated":false,"LastScanSeq":"2076093285","ModifiedDate":"2022-11-15T10:36:03.9191928Z"}]}