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

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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": "2024-11-30T17:57:35.3966037Z",
      "UninstalledDate": null,
      "AgentVersion": "1.3.3.35",
      "LastSeenDate": "2024-12-28T17:57:35.3966037Z",
      "LastModifiedDate": "2024-11-30T19:57:35.3966037Z",
      "TrafficCountLast24Hours": 2134,
      "DNSPolicyID": "58f9924c-7521-4928-9d91-d59af23c3cfb",
      "DNSPolicyName": "Securedns High Protection",
      "MachineID": "37de66d9c7fc4de6b75325c9638e766937de66d9c7fc4de6b75325c9638e7669:::58fc4151a6b5464b95c058fc4151a6b5464b95c0:::58fc4151a6b5464b95c058fc4151a6b5464b95c0",
      "KC": "3775-9A33-5BBA-4340-99E0",
      "MasterKC": "F86C-EDFE-DE1F-47FD-AAA9"
    },
    {
      "HostName": "Computer2",
      "IsVirtualMachine": false,
      "DNSAgentStatus": "Installed",
      "InstalledDate": "2024-10-30T17:57:35.3966037Z",
      "UninstalledDate": null,
      "AgentVersion": "1.3.3.35",
      "LastSeenDate": "2024-12-26T17:57:35.3966037Z",
      "LastModifiedDate": "2024-10-30T21:57:35.3966037Z",
      "TrafficCountLast24Hours": 2134,
      "DNSPolicyID": "a62ccdc7-9185-4856-99c0-fa02e3285c36",
      "DNSPolicyName": "Securedns High Protection",
      "MachineID": "71a7d5b0884b494098fe4db7f3bf29f971a7d5b0884b494098fe4db7f3bf29f9:::f7a1bf8c09074bab9485f7a1bf8c09074bab9485:::f7a1bf8c09074bab9485f7a1bf8c09074bab9485",
      "KC": "3775-9A33-5BBA-4340-99E0",
      "MasterKC": "F86C-EDFE-DE1F-47FD-AAA9"
    }
  ],
  "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>58f9924c-7521-4928-9d91-d59af23c3cfb</DNSPolicyID>
      <DNSPolicyName>Securedns High Protection</DNSPolicyName>
      <HostName>Computer1</HostName>
      <InstalledDate>2024-11-30T17:57:35.3966037Z</InstalledDate>
      <IsVirtualMachine>false</IsVirtualMachine>
      <KC>3775-9A33-5BBA-4340-99E0</KC>
      <LastModifiedDate>2024-11-30T19:57:35.3966037Z</LastModifiedDate>
      <LastSeenDate>2024-12-28T17:57:35.3966037Z</LastSeenDate>
      <MachineID>37de66d9c7fc4de6b75325c9638e766937de66d9c7fc4de6b75325c9638e7669:::58fc4151a6b5464b95c058fc4151a6b5464b95c0:::58fc4151a6b5464b95c058fc4151a6b5464b95c0</MachineID>
      <MasterKC>F86C-EDFE-DE1F-47FD-AAA9</MasterKC>
      <TrafficCountLast24Hours>2134</TrafficCountLast24Hours>
      <UninstalledDate i:nil="true" />
    </DNSPEndpointInfo>
    <DNSPEndpointInfo>
      <AgentVersion>1.3.3.35</AgentVersion>
      <DNSAgentStatus>Installed</DNSAgentStatus>
      <DNSPolicyID>a62ccdc7-9185-4856-99c0-fa02e3285c36</DNSPolicyID>
      <DNSPolicyName>Securedns High Protection</DNSPolicyName>
      <HostName>Computer2</HostName>
      <InstalledDate>2024-10-30T17:57:35.3966037Z</InstalledDate>
      <IsVirtualMachine>false</IsVirtualMachine>
      <KC>3775-9A33-5BBA-4340-99E0</KC>
      <LastModifiedDate>2024-10-30T21:57:35.3966037Z</LastModifiedDate>
      <LastSeenDate>2024-12-26T17:57:35.3966037Z</LastSeenDate>
      <MachineID>71a7d5b0884b494098fe4db7f3bf29f971a7d5b0884b494098fe4db7f3bf29f9:::f7a1bf8c09074bab9485f7a1bf8c09074bab9485:::f7a1bf8c09074bab9485f7a1bf8c09074bab9485</MachineID>
      <MasterKC>F86C-EDFE-DE1F-47FD-AAA9</MasterKC>
      <TrafficCountLast24Hours>2134</TrafficCountLast24Hours>
      <UninstalledDate i:nil="true" />
    </DNSPEndpointInfo>
  </QueryResults>
</DNSPAgentStatus>

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