Unity API Documentation

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

Returns DNS protection (DNSP) status information for all endpoints matching the specified criteria.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
keyCode

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

 string

Required
machineId

A machine ID for which DNSP status information is to be retrieved. If omitted, information for all endpoints is for the given site is retrieved.

 string

None.
modifiedSince

If specified, returns all DNSP status entries, that were modified after (or at) the given date.

 date

None.
batchSize

Specifies the maximum number of entries returned per request. Valid values range from 1 to 1000.

 integer

Default value is 50
continuation

A continuation token for batched requests

 string

None.

URI Sample(s)

GET
https://unityapi.webrootcloudav.com/service/api/status/gsm/dnsp/3515-3EC8-3018-4DAB-A776?batchSize=200
GET
https://unityapi.webrootcloudav.com/service/api/status/gsm/dnsp/3515-3EC8-3018-4DAB-A776?batchSize=200&continuation=H4sIAAAAAAAEAM1SS07DMBQckiBVXXXDATgB8bd2d5RuAmkLilhHsetISGkrlMBVuBBnQGLJgnvgkLRdgYQEEgtrPO_Nm-dn-z4EonWeNG5NcAZgFCN5eT4fEVy2QHHVAkPaAsd1CwI3HhB2dRTHvm7nwnDqSRDjxAPTTDauboxZ2RV1jq_IGLs6jtfAk6sLvHnpcIrBdLlMgUFSt5vMNd50mvXuaYc-2WXC
GET
https://unityapi.webrootcloudav.com/service/api/status/gsm/dnsp/3515-3EC8-3018-4DAB-A776?machineId=8a8a1a12345c1ca9eelw78965a9c8d789c6fc75381d1234567890fffa91c138:::57cf6d537c9a3e12345bbdaa8ba2a98765c1c5c2:::57cf6d123c9a3e12345bbdaa8ba2a98765c1c5c2
GET
https://unityapi.webrootcloudav.com/service/api/status/gsm/dnsp/3515-3EC8-3018-4DAB-A776?modifiedSince=2019-01-01T22:30:00.000Z

Body Parameters

None.

Response Information

Resource Description

Returns DNSP status information for the 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

DNSPAgentStatus
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 DNSP endpoints returned in the current request.

 integer

None.
QueryResults

Endpoint information matching the given query parameters.

 Collection of DNSPEndpointInfo

None.

Sample Response

{
  "QueryResults": [
    {
      "HostName": "Computer1",
      "IsVirtualMachine": false,
      "DNSAgentStatus": "Installed",
      "InstalledDate": "2020-04-25T04:14:44.8797188Z",
      "UninstalledDate": null,
      "AgentVersion": "1.3.3.35",
      "LastSeenDate": "2020-05-23T04:14:44.8797188Z",
      "LastModifiedDate": "2020-04-25T06:14:44.8797188Z",
      "TrafficCountLast24Hours": 2134,
      "DNSPolicyID": "0db624ed-e563-4d94-9874-5fbe5e181296",
      "DNSPolicyName": "Securedns High Protection",
      "MachineID": "41694c99b74641c3b12375eb57c66c9241694c99b74641c3b12375eb57c66c92:::fce125826c434b0384b5fce125826c434b0384b5:::fce125826c434b0384b5fce125826c434b0384b5",
      "KC": "8B8C-815A-8DAC-47C6-B1ED",
      "MasterKC": "D650-FE12-6F0C-419A-92F2"
    },
    {
      "HostName": "Computer2",
      "IsVirtualMachine": false,
      "DNSAgentStatus": "Installed",
      "InstalledDate": "2020-03-25T04:14:44.8797188Z",
      "UninstalledDate": null,
      "AgentVersion": "1.3.3.35",
      "LastSeenDate": "2020-05-21T04:14:44.8797188Z",
      "LastModifiedDate": "2020-03-25T08:14:44.8797188Z",
      "TrafficCountLast24Hours": 2134,
      "DNSPolicyID": "30baca70-935f-4a2e-b263-48933fcf111a",
      "DNSPolicyName": "Securedns High Protection",
      "MachineID": "15f2bb7f0b11453795b50aaefca6068015f2bb7f0b11453795b50aaefca60680:::7eaf980583b04a68b4197eaf980583b04a68b419:::7eaf980583b04a68b4197eaf980583b04a68b419",
      "KC": "8B8C-815A-8DAC-47C6-B1ED",
      "MasterKC": "D650-FE12-6F0C-419A-92F2"
    }
  ],
  "ContinuationToken": null,
  "ContinuationURI": null,
  "Count": 2
}                    
<DNSPAgentStatus 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>
    <DNSPEndpointInfo>
      <AgentVersion>1.3.3.35</AgentVersion>
      <DNSAgentStatus>Installed</DNSAgentStatus>
      <DNSPolicyID>0db624ed-e563-4d94-9874-5fbe5e181296</DNSPolicyID>
      <DNSPolicyName>Securedns High Protection</DNSPolicyName>
      <HostName>Computer1</HostName>
      <InstalledDate>2020-04-25T04:14:44.8797188Z</InstalledDate>
      <IsVirtualMachine>false</IsVirtualMachine>
      <KC>8B8C-815A-8DAC-47C6-B1ED</KC>
      <LastModifiedDate>2020-04-25T06:14:44.8797188Z</LastModifiedDate>
      <LastSeenDate>2020-05-23T04:14:44.8797188Z</LastSeenDate>
      <MachineID>41694c99b74641c3b12375eb57c66c9241694c99b74641c3b12375eb57c66c92:::fce125826c434b0384b5fce125826c434b0384b5:::fce125826c434b0384b5fce125826c434b0384b5</MachineID>
      <MasterKC>D650-FE12-6F0C-419A-92F2</MasterKC>
      <TrafficCountLast24Hours>2134</TrafficCountLast24Hours>
      <UninstalledDate i:nil="true" />
    </DNSPEndpointInfo>
    <DNSPEndpointInfo>
      <AgentVersion>1.3.3.35</AgentVersion>
      <DNSAgentStatus>Installed</DNSAgentStatus>
      <DNSPolicyID>30baca70-935f-4a2e-b263-48933fcf111a</DNSPolicyID>
      <DNSPolicyName>Securedns High Protection</DNSPolicyName>
      <HostName>Computer2</HostName>
      <InstalledDate>2020-03-25T04:14:44.8797188Z</InstalledDate>
      <IsVirtualMachine>false</IsVirtualMachine>
      <KC>8B8C-815A-8DAC-47C6-B1ED</KC>
      <LastModifiedDate>2020-03-25T08:14:44.8797188Z</LastModifiedDate>
      <LastSeenDate>2020-05-21T04:14:44.8797188Z</LastSeenDate>
      <MachineID>15f2bb7f0b11453795b50aaefca6068015f2bb7f0b11453795b50aaefca60680:::7eaf980583b04a68b4197eaf980583b04a68b419:::7eaf980583b04a68b4197eaf980583b04a68b419</MachineID>
      <MasterKC>D650-FE12-6F0C-419A-92F2</MasterKC>
      <TrafficCountLast24Hours>2134</TrafficCountLast24Hours>
      <UninstalledDate i:nil="true" />
    </DNSPEndpointInfo>
  </QueryResults>
</DNSPAgentStatus>