GET /service/api/status/gsm/{keyCode}
 ?machineId={machineId}
 &returnedInfo={returnedInfo}
 &modifiedSince={modifiedSince}
 &batchSize={batchSize}
 &continuation={continuation}

Returns agent status information for all endpoints matching the specified criteria.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
keyCode

A GSM keycode for which agent status information is to be retrieved.

string

Required

machineId

A machine ID for which agent status is to be retrieved. If omitted, information for all endpoints is retrieved. All query parameters must be URL encoded so e.g. kxoga2:12345 looks like kxoga2%3A12345

string

None.

returnedInfo

A comma separated list of classes of information to be contained in the response data (BasicInfo,ExtendedInfo,TimesAndStats,Scheduling,EnabledFeatures,SystemAnalyzer,OSAndVersions). If omitted, all classes of information are returned

string

None.

modifiedSince

If specified, returns all agent status entries, that were modified after (or at) the given date. All query parameters must be URL encoded so e.g. 2012-12-31T22:00:00.000Z looks like 2012-12-31T22%3A00%3A00.000Z

date

None.

batchSize

Specifies the number of entries returned per request. If omitted, defaults to 50

integer

Default value is 50

continuation

A continuation token for batched requests

string

None.

Body Parameters

None.

Response Information

Resource Description

Returns a list of endpoints matching the given criteria. If more items would be returned, than specified by 'batchSize', a continuation URI is returned, which can be used to retrieve the next batch of items

AgentStatus
NameDescriptionTypeAdditional Information
ContinuationToken

Provides a continuation token for follow-up calls if more data is available than the given batch size.

string

None.

ContinuationURI

Provides a URI for follow-up calls if more data is available than the given batch size.

string

None.

Count

Contains the number of endpoints returned in the current request.

integer

None.

QueryResults

Endpoint information matching the given query paramaters.

Collection of EndpointInfo

None.

Sample Response

{
  "QueryResults": [
    {
      "BasicInfo": {
        "StatusRefreshTime": "2019-05-22T20:59:47.8660195Z",
        "Managed": false,
        "SKU": "Webroot SecureAnywhere Endpoint Protection",
        "PartnerNumber": 0,
        "Version": "9.0.13.58",
        "ActiveThreats": 0,
        "DeviceType": "PC",
        "AttentionRequired": false,
        "Infected": false
      },
      "ExtendedInfo": {
        "Uninstalled": false,
        "Language": "en",
        "IsExpired": false,
        "DaysRemaining": 122,
        "ExpirationDate": "2019-09-21T21:09:47.8660195Z",
        "RemediationEnabled": true,
        "ThreatBlocked": false,
        "WasJustInfected": true,
        "HasBeenInfected": true,
        "LatestThreat": "c:\\users\\administrator\\downloads\\eicar_com\\eicar - copy.com|Eicar-Test-Virus|56A0F8A9",
        "CurrentlyCleaning": false,
        "CleanShutdown": true,
        "ManualAgentShutdown": false,
        "AgentStartupTime": "2019-05-22T16:09:47.8660195Z",
        "SystemState": 1,
        "SystemStateUpdated": "2019-05-22T16:09:47.8660195Z"
      },
      "TimesAndStats": {
        "LastGarbageRemovalTime": null,
        "LastGarbageRemovalSize": 0,
        "TotalGarbageRemovalSize": 0,
        "LastScan": "2019-05-22T19:09:47.8660195Z",
        "LastScanDuration": 174,
        "LastScanCount": 283812,
        "ScanCount": 3,
        "ThreatsRemoved": 1,
        "LastQuickScan": null,
        "LastQuickScanDuration": 0,
        "LastFullScan": "2019-05-22T19:09:47.8660195Z",
        "LastFullScanDuration": 712,
        "LastCustomScan": null,
        "LastCustomScanDuration": 0,
        "LastDeepScan": null,
        "LastDeepScanDuration": 0
      },
      "Scheduling": {
        "ScheduledScansEnabled": true,
        "ScheduledScanFrequency": 0,
        "ScheduledScanTime": "10:00",
        "ScanWhenIdle": false,
        "ScanOnBootup": false,
        "ActiveScans": 0
      },
      "EnabledFeatures": {
        "ProtectionEnabled": true,
        "RootkitShieldEnabled": true,
        "WebThreatShieldEnabled": true,
        "USBShieldEnabled": true,
        "OfflineShieldEnabled": true,
        "FirewallEnabled": true,
        "InfraredEnabled": true,
        "IDShieldEnabled": true,
        "PhishingShieldEnabled": true,
        "IsSilent": false
      },
      "SystemAnalyzer": {
        "SystemAnalyzerScore": 0,
        "HardwareScore": "",
        "SoftwareScore": "",
        "ThreatsScore": ""
      },
      "OSAndVersions": {
        "OSBuild": 9600,
        "OSPlatform": 64,
        "OSLanguage": 1033,
        "CurrentUser": "Administrator",
        "NumUsers": 2,
        "MaxUsers": 2,
        "internalIP": "10.37.33.166",
        "MACAddress": "D1-F0-F2-16-5F-DF",
        "ADSTRING": "",
        "Workgroup": "WORKGROUP",
        "DNSServer": "10.209.84.177",
        "BinType": "SMEINSTALL",
        "Email": "",
        "OtherAVProduct": "",
        "OtherAVProductVersion": "",
        "IsOtherAVEnabled": false,
        "IsOtherAVUpdated": false,
        "PrimaryBrowser": "IE",
        "PrimaryBrowserVersion": "9.11.9600.18125",
        "IsFirewallEnabled": true,
        "IsVirtualMachine": false,
        "IPV4": "10.37.33.166",
        "IPV6": "",
        "FQDN": "",
        "NTDOMAIN": "",
        "LDAPOID": "",
        "LDAPDN": ""
      },
      "MasterKC": "280F-BAF7-9B6C-48E2-82AB",
      "KC": "66DF-4C9F-316B-4973-B0A2",
      "MachineID": "25A303875E434AD3938BDCEBE53A172F:::0007B8688232444D9CF147938F88F2AD:::0007B8688232444D9CF147938F88F2AD",
      "LastChanged": "2019-05-20T21:09:47.8660195Z",
      "HostName": "Computer1",
      "IPAddress": "95.120.208.251",
      "ClientVersion": "9.0.13.58",
      "OS": "Windows Server 2012 (Build 9600) 64bit",
      "FirstSeen": "2019-04-22T21:09:47.8660195Z",
      "LastSeen": "2019-05-21T21:09:47.8660195Z",
      "TimesSeen": 9,
      "Hidden": false,
      "Deactivated": false,
      "ActivationStatusTime": null
    },
    {
      "BasicInfo": {
        "StatusRefreshTime": "2019-05-22T20:49:47.8669971Z",
        "Managed": false,
        "SKU": "Webroot SecureAnywhere Endpoint Protection",
        "PartnerNumber": 0,
        "Version": "9.0.13.58",
        "ActiveThreats": 0,
        "DeviceType": "PC",
        "AttentionRequired": false,
        "Infected": false
      },
      "ExtendedInfo": {
        "Uninstalled": false,
        "Language": "en",
        "IsExpired": false,
        "DaysRemaining": 122,
        "ExpirationDate": "2019-09-21T21:09:47.8669971Z",
        "RemediationEnabled": true,
        "ThreatBlocked": false,
        "WasJustInfected": true,
        "HasBeenInfected": true,
        "LatestThreat": "c:\\users\\administrator\\downloads\\eicar_com\\eicar - copy.com|Eicar-Test-Virus|56A0F8A9",
        "CurrentlyCleaning": false,
        "CleanShutdown": true,
        "ManualAgentShutdown": false,
        "AgentStartupTime": "2019-05-22T11:09:47.8669971Z",
        "SystemState": 1,
        "SystemStateUpdated": "2019-05-22T11:09:47.8669971Z"
      },
      "TimesAndStats": {
        "LastGarbageRemovalTime": null,
        "LastGarbageRemovalSize": 0,
        "TotalGarbageRemovalSize": 0,
        "LastScan": "2019-05-22T17:09:47.8669971Z",
        "LastScanDuration": 145,
        "LastScanCount": 231961,
        "ScanCount": 2,
        "ThreatsRemoved": 1,
        "LastQuickScan": null,
        "LastQuickScanDuration": 0,
        "LastFullScan": "2019-05-22T17:09:47.8669971Z",
        "LastFullScanDuration": 799,
        "LastCustomScan": null,
        "LastCustomScanDuration": 0,
        "LastDeepScan": null,
        "LastDeepScanDuration": 0
      },
      "Scheduling": {
        "ScheduledScansEnabled": true,
        "ScheduledScanFrequency": 0,
        "ScheduledScanTime": "10:00",
        "ScanWhenIdle": false,
        "ScanOnBootup": false,
        "ActiveScans": 0
      },
      "EnabledFeatures": {
        "ProtectionEnabled": true,
        "RootkitShieldEnabled": true,
        "WebThreatShieldEnabled": true,
        "USBShieldEnabled": true,
        "OfflineShieldEnabled": true,
        "FirewallEnabled": true,
        "InfraredEnabled": true,
        "IDShieldEnabled": true,
        "PhishingShieldEnabled": true,
        "IsSilent": false
      },
      "SystemAnalyzer": {
        "SystemAnalyzerScore": 0,
        "HardwareScore": "",
        "SoftwareScore": "",
        "ThreatsScore": ""
      },
      "OSAndVersions": {
        "OSBuild": 9600,
        "OSPlatform": 64,
        "OSLanguage": 1033,
        "CurrentUser": "Administrator",
        "NumUsers": 2,
        "MaxUsers": 2,
        "internalIP": "10.189.203.194",
        "MACAddress": "29-F9-8A-0E-A5-87",
        "ADSTRING": "",
        "Workgroup": "WORKGROUP",
        "DNSServer": "10.237.124.197",
        "BinType": "SMEINSTALL",
        "Email": "",
        "OtherAVProduct": "",
        "OtherAVProductVersion": "",
        "IsOtherAVEnabled": false,
        "IsOtherAVUpdated": false,
        "PrimaryBrowser": "IE",
        "PrimaryBrowserVersion": "9.11.9600.18125",
        "IsFirewallEnabled": true,
        "IsVirtualMachine": false,
        "IPV4": "10.189.203.194",
        "IPV6": "",
        "FQDN": "",
        "NTDOMAIN": "",
        "LDAPOID": "",
        "LDAPDN": ""
      },
      "MasterKC": "280F-BAF7-9B6C-48E2-82AB",
      "KC": "66DF-4C9F-316B-4973-B0A2",
      "MachineID": "D6B018D0C57D48ADB21D69B7A7C4B231:::C0054B67FD93432DBBB36793C3CBD18C:::C0054B67FD93432DBBB36793C3CBD18C",
      "LastChanged": "2019-05-18T21:09:47.8669971Z",
      "HostName": "Computer2",
      "IPAddress": "95.211.11.225",
      "ClientVersion": "9.0.13.58",
      "OS": "Windows Server 2012 (Build 9600) 64bit",
      "FirstSeen": "2019-03-22T21:09:47.8669971Z",
      "LastSeen": "2019-05-20T21:09:47.8669971Z",
      "TimesSeen": 20,
      "Hidden": false,
      "Deactivated": false,
      "ActivationStatusTime": null
    }
  ],
  "ContinuationToken": null,
  "ContinuationURI": null,
  "Count": 2
}                    
<AgentStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models">
  <ContinuationToken i:nil="true" />
  <ContinuationURI i:nil="true" />
  <Count>2</Count>
  <QueryResults>
    <EndpointInfo>
      <ActivationStatusTime i:nil="true" />
      <BasicInfo>
        <ActiveThreats>0</ActiveThreats>
        <AttentionRequired>false</AttentionRequired>
        <DeviceType>PC</DeviceType>
        <Infected>false</Infected>
        <Managed>false</Managed>
        <PartnerNumber>0</PartnerNumber>
        <SKU>Webroot SecureAnywhere Endpoint Protection</SKU>
        <StatusRefreshTime>2019-05-22T20:59:47.8660195Z</StatusRefreshTime>
        <Version>9.0.13.58</Version>
      </BasicInfo>
      <ClientVersion>9.0.13.58</ClientVersion>
      <Deactivated>false</Deactivated>
      <EnabledFeatures>
        <FirewallEnabled>true</FirewallEnabled>
        <IDShieldEnabled>true</IDShieldEnabled>
        <InfraredEnabled>true</InfraredEnabled>
        <IsSilent>false</IsSilent>
        <OfflineShieldEnabled>true</OfflineShieldEnabled>
        <PhishingShieldEnabled>true</PhishingShieldEnabled>
        <ProtectionEnabled>true</ProtectionEnabled>
        <RootkitShieldEnabled>true</RootkitShieldEnabled>
        <USBShieldEnabled>true</USBShieldEnabled>
        <WebThreatShieldEnabled>true</WebThreatShieldEnabled>
      </EnabledFeatures>
      <ExtendedInfo>
        <AgentStartupTime>2019-05-22T16:09:47.8660195Z</AgentStartupTime>
        <CleanShutdown>true</CleanShutdown>
        <CurrentlyCleaning>false</CurrentlyCleaning>
        <DaysRemaining>122</DaysRemaining>
        <ExpirationDate>2019-09-21T21:09:47.8660195Z</ExpirationDate>
        <HasBeenInfected>true</HasBeenInfected>
        <IsExpired>false</IsExpired>
        <Language>en</Language>
        <LatestThreat>c:\users\administrator\downloads\eicar_com\eicar - copy.com|Eicar-Test-Virus|56A0F8A9</LatestThreat>
        <ManualAgentShutdown>false</ManualAgentShutdown>
        <RemediationEnabled>true</RemediationEnabled>
        <SystemState>1</SystemState>
        <SystemStateUpdated>2019-05-22T16:09:47.8660195Z</SystemStateUpdated>
        <ThreatBlocked>false</ThreatBlocked>
        <Uninstalled>false</Uninstalled>
        <WasJustInfected>true</WasJustInfected>
      </ExtendedInfo>
      <FirstSeen>2019-04-22T21:09:47.8660195Z</FirstSeen>
      <Hidden>false</Hidden>
      <HostName>Computer1</HostName>
      <IPAddress>95.120.208.251</IPAddress>
      <KC>66DF-4C9F-316B-4973-B0A2</KC>
      <LastChanged>2019-05-20T21:09:47.8660195Z</LastChanged>
      <LastSeen>2019-05-21T21:09:47.8660195Z</LastSeen>
      <MachineID>25A303875E434AD3938BDCEBE53A172F:::0007B8688232444D9CF147938F88F2AD:::0007B8688232444D9CF147938F88F2AD</MachineID>
      <MasterKC>280F-BAF7-9B6C-48E2-82AB</MasterKC>
      <OS>Windows Server 2012 (Build 9600) 64bit</OS>
      <OSAndVersions>
        <ADSTRING></ADSTRING>
        <BinType>SMEINSTALL</BinType>
        <CurrentUser>Administrator</CurrentUser>
        <DNSServer>10.209.84.177</DNSServer>
        <Email></Email>
        <FQDN></FQDN>
        <IPV4>10.37.33.166</IPV4>
        <IPV6></IPV6>
        <IsFirewallEnabled>true</IsFirewallEnabled>
        <IsOtherAVEnabled>false</IsOtherAVEnabled>
        <IsOtherAVUpdated>false</IsOtherAVUpdated>
        <IsVirtualMachine>false</IsVirtualMachine>
        <LDAPDN></LDAPDN>
        <LDAPOID></LDAPOID>
        <MACAddress>D1-F0-F2-16-5F-DF</MACAddress>
        <MaxUsers>2</MaxUsers>
        <NTDOMAIN></NTDOMAIN>
        <NumUsers>2</NumUsers>
        <OSBuild>9600</OSBuild>
        <OSLanguage>1033</OSLanguage>
        <OSPlatform>64</OSPlatform>
        <OtherAVProduct></OtherAVProduct>
        <OtherAVProductVersion></OtherAVProductVersion>
        <PrimaryBrowser>IE</PrimaryBrowser>
        <PrimaryBrowserVersion>9.11.9600.18125</PrimaryBrowserVersion>
        <Workgroup>WORKGROUP</Workgroup>
        <internalIP>10.37.33.166</internalIP>
      </OSAndVersions>
      <Scheduling>
        <ActiveScans>0</ActiveScans>
        <ScanOnBootup>false</ScanOnBootup>
        <ScanWhenIdle>false</ScanWhenIdle>
        <ScheduledScanFrequency>0</ScheduledScanFrequency>
        <ScheduledScanTime>10:00</ScheduledScanTime>
        <ScheduledScansEnabled>true</ScheduledScansEnabled>
      </Scheduling>
      <SystemAnalyzer>
        <HardwareScore></HardwareScore>
        <SoftwareScore></SoftwareScore>
        <SystemAnalyzerScore>0</SystemAnalyzerScore>
        <ThreatsScore></ThreatsScore>
      </SystemAnalyzer>
      <TimesAndStats>
        <LastCustomScan i:nil="true" />
        <LastCustomScanDuration>0</LastCustomScanDuration>
        <LastDeepScan i:nil="true" />
        <LastDeepScanDuration>0</LastDeepScanDuration>
        <LastFullScan>2019-05-22T19:09:47.8660195Z</LastFullScan>
        <LastFullScanDuration>712</LastFullScanDuration>
        <LastGarbageRemovalSize>0</LastGarbageRemovalSize>
        <LastGarbageRemovalTime i:nil="true" />
        <LastQuickScan i:nil="true" />
        <LastQuickScanDuration>0</LastQuickScanDuration>
        <LastScan>2019-05-22T19:09:47.8660195Z</LastScan>
        <LastScanCount>283812</LastScanCount>
        <LastScanDuration>174</LastScanDuration>
        <ScanCount>3</ScanCount>
        <ThreatsRemoved>1</ThreatsRemoved>
        <TotalGarbageRemovalSize>0</TotalGarbageRemovalSize>
      </TimesAndStats>
      <TimesSeen>9</TimesSeen>
    </EndpointInfo>
    <EndpointInfo>
      <ActivationStatusTime i:nil="true" />
      <BasicInfo>
        <ActiveThreats>0</ActiveThreats>
        <AttentionRequired>false</AttentionRequired>
        <DeviceType>PC</DeviceType>
        <Infected>false</Infected>
        <Managed>false</Managed>
        <PartnerNumber>0</PartnerNumber>
        <SKU>Webroot SecureAnywhere Endpoint Protection</SKU>
        <StatusRefreshTime>2019-05-22T20:49:47.8669971Z</StatusRefreshTime>
        <Version>9.0.13.58</Version>
      </BasicInfo>
      <ClientVersion>9.0.13.58</ClientVersion>
      <Deactivated>false</Deactivated>
      <EnabledFeatures>
        <FirewallEnabled>true</FirewallEnabled>
        <IDShieldEnabled>true</IDShieldEnabled>
        <InfraredEnabled>true</InfraredEnabled>
        <IsSilent>false</IsSilent>
        <OfflineShieldEnabled>true</OfflineShieldEnabled>
        <PhishingShieldEnabled>true</PhishingShieldEnabled>
        <ProtectionEnabled>true</ProtectionEnabled>
        <RootkitShieldEnabled>true</RootkitShieldEnabled>
        <USBShieldEnabled>true</USBShieldEnabled>
        <WebThreatShieldEnabled>true</WebThreatShieldEnabled>
      </EnabledFeatures>
      <ExtendedInfo>
        <AgentStartupTime>2019-05-22T11:09:47.8669971Z</AgentStartupTime>
        <CleanShutdown>true</CleanShutdown>
        <CurrentlyCleaning>false</CurrentlyCleaning>
        <DaysRemaining>122</DaysRemaining>
        <ExpirationDate>2019-09-21T21:09:47.8669971Z</ExpirationDate>
        <HasBeenInfected>true</HasBeenInfected>
        <IsExpired>false</IsExpired>
        <Language>en</Language>
        <LatestThreat>c:\users\administrator\downloads\eicar_com\eicar - copy.com|Eicar-Test-Virus|56A0F8A9</LatestThreat>
        <ManualAgentShutdown>false</ManualAgentShutdown>
        <RemediationEnabled>true</RemediationEnabled>
        <SystemState>1</SystemState>
        <SystemStateUpdated>2019-05-22T11:09:47.8669971Z</SystemStateUpdated>
        <ThreatBlocked>false</ThreatBlocked>
        <Uninstalled>false</Uninstalled>
        <WasJustInfected>true</WasJustInfected>
      </ExtendedInfo>
      <FirstSeen>2019-03-22T21:09:47.8669971Z</FirstSeen>
      <Hidden>false</Hidden>
      <HostName>Computer2</HostName>
      <IPAddress>95.211.11.225</IPAddress>
      <KC>66DF-4C9F-316B-4973-B0A2</KC>
      <LastChanged>2019-05-18T21:09:47.8669971Z</LastChanged>
      <LastSeen>2019-05-20T21:09:47.8669971Z</LastSeen>
      <MachineID>D6B018D0C57D48ADB21D69B7A7C4B231:::C0054B67FD93432DBBB36793C3CBD18C:::C0054B67FD93432DBBB36793C3CBD18C</MachineID>
      <MasterKC>280F-BAF7-9B6C-48E2-82AB</MasterKC>
      <OS>Windows Server 2012 (Build 9600) 64bit</OS>
      <OSAndVersions>
        <ADSTRING></ADSTRING>
        <BinType>SMEINSTALL</BinType>
        <CurrentUser>Administrator</CurrentUser>
        <DNSServer>10.237.124.197</DNSServer>
        <Email></Email>
        <FQDN></FQDN>
        <IPV4>10.189.203.194</IPV4>
        <IPV6></IPV6>
        <IsFirewallEnabled>true</IsFirewallEnabled>
        <IsOtherAVEnabled>false</IsOtherAVEnabled>
        <IsOtherAVUpdated>false</IsOtherAVUpdated>
        <IsVirtualMachine>false</IsVirtualMachine>
        <LDAPDN></LDAPDN>
        <LDAPOID></LDAPOID>
        <MACAddress>29-F9-8A-0E-A5-87</MACAddress>
        <MaxUsers>2</MaxUsers>
        <NTDOMAIN></NTDOMAIN>
        <NumUsers>2</NumUsers>
        <OSBuild>9600</OSBuild>
        <OSLanguage>1033</OSLanguage>
        <OSPlatform>64</OSPlatform>
        <OtherAVProduct></OtherAVProduct>
        <OtherAVProductVersion></OtherAVProductVersion>
        <PrimaryBrowser>IE</PrimaryBrowser>
        <PrimaryBrowserVersion>9.11.9600.18125</PrimaryBrowserVersion>
        <Workgroup>WORKGROUP</Workgroup>
        <internalIP>10.189.203.194</internalIP>
      </OSAndVersions>
      <Scheduling>
        <ActiveScans>0</ActiveScans>
        <ScanOnBootup>false</ScanOnBootup>
        <ScanWhenIdle>false</ScanWhenIdle>
        <ScheduledScanFrequency>0</ScheduledScanFrequency>
        <ScheduledScanTime>10:00</ScheduledScanTime>
        <ScheduledScansEnabled>true</ScheduledScansEnabled>
      </Scheduling>
      <SystemAnalyzer>
        <HardwareScore></HardwareScore>
        <SoftwareScore></SoftwareScore>
        <SystemAnalyzerScore>0</SystemAnalyzerScore>
        <ThreatsScore></ThreatsScore>
      </SystemAnalyzer>
      <TimesAndStats>
        <LastCustomScan i:nil="true" />
        <LastCustomScanDuration>0</LastCustomScanDuration>
        <LastDeepScan i:nil="true" />
        <LastDeepScanDuration>0</LastDeepScanDuration>
        <LastFullScan>2019-05-22T17:09:47.8669971Z</LastFullScan>
        <LastFullScanDuration>799</LastFullScanDuration>
        <LastGarbageRemovalSize>0</LastGarbageRemovalSize>
        <LastGarbageRemovalTime i:nil="true" />
        <LastQuickScan i:nil="true" />
        <LastQuickScanDuration>0</LastQuickScanDuration>
        <LastScan>2019-05-22T17:09:47.8669971Z</LastScan>
        <LastScanCount>231961</LastScanCount>
        <LastScanDuration>145</LastScanDuration>
        <ScanCount>2</ScanCount>
        <ThreatsRemoved>1</ThreatsRemoved>
        <TotalGarbageRemovalSize>0</TotalGarbageRemovalSize>
      </TimesAndStats>
      <TimesSeen>20</TimesSeen>
    </EndpointInfo>
  </QueryResults>
</AgentStatus>