GET /service/api/status/site/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 site 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 generated traffic 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/site/dnsp/3515-3EC8-3018-4DAB-A776?batchSize=200
|
GET
|
https://unityapi.webrootcloudav.com/service/api/status/site/dnsp/3515-3EC8-3018-4DAB-A776?batchSize=200&continuation=H4sIAAAAAAAEAM1SS07DMBQckiBVXXXDATgB8bd2d5RuAmkLilhHsetISGkrlMBVuBBnQGLJgnvgkLRdgYQEEgtrPO_Nm-dn-z4EonWeNG5NcAZgFCN5eT4fEVy2QHHVAkPaAsd1CwI3HhB2dRTHvm7nwnDqSRDjxAPTTDauboxZ2RV1jq_IGLs6jtfAk6sLvHnpcIrBdLlMgUFSt5vMNd50mvXuaYc-2WXC
|
GET
|
https://unityapi.webrootcloudav.com/service/api/status/site/dnsp/3515-3EC8-3018-4DAB-A776?machineId=8a8a1a12345c1ca9eelw78965a9c8d789c6fc75381d1234567890fffa91c138:::57cf6d537c9a3e12345bbdaa8ba2a98765c1c5c2:::57cf6d123c9a3e12345bbdaa8ba2a98765c1c5c2
|
GET
|
https://unityapi.webrootcloudav.com/service/api/status/site/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
DNSPAgentStatusName | 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-09-22T15:06:58.5663219Z", "UninstalledDate": null, "AgentVersion": "1.3.3.35", "LastSeenDate": "2024-10-20T15:06:58.5663219Z", "LastModifiedDate": "2024-09-22T17:06:58.5663219Z", "TrafficCountLast24Hours": 2134, "DNSPolicyID": "e2d4e2d2-eb38-4909-ba67-92f7447918dc", "DNSPolicyName": "Securedns High Protection", "MachineID": "725cecb909c44174ab8c407f1be77c29725cecb909c44174ab8c407f1be77c29:::0968f926072c4cd080660968f926072c4cd08066:::0968f926072c4cd080660968f926072c4cd08066", "KC": "8436-D3F9-0E16-4722-B6D6", "MasterKC": "5311-63A0-0FF9-4713-B2A1" }, { "HostName": "Computer2", "IsVirtualMachine": false, "DNSAgentStatus": "Installed", "InstalledDate": "2024-08-22T15:06:58.5663219Z", "UninstalledDate": null, "AgentVersion": "1.3.3.35", "LastSeenDate": "2024-10-18T15:06:58.5663219Z", "LastModifiedDate": "2024-08-22T19:06:58.5663219Z", "TrafficCountLast24Hours": 2134, "DNSPolicyID": "a322451f-d3ec-4b25-ac46-96fb0701ecb3", "DNSPolicyName": "Securedns High Protection", "MachineID": "f0b7fcea0b7f4330a8573e1012eb0918f0b7fcea0b7f4330a8573e1012eb0918:::9e2bcf223ba041c295bc9e2bcf223ba041c295bc:::9e2bcf223ba041c295bc9e2bcf223ba041c295bc", "KC": "8436-D3F9-0E16-4722-B6D6", "MasterKC": "5311-63A0-0FF9-4713-B2A1" } ], "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>e2d4e2d2-eb38-4909-ba67-92f7447918dc</DNSPolicyID> <DNSPolicyName>Securedns High Protection</DNSPolicyName> <HostName>Computer1</HostName> <InstalledDate>2024-09-22T15:06:58.5663219Z</InstalledDate> <IsVirtualMachine>false</IsVirtualMachine> <KC>8436-D3F9-0E16-4722-B6D6</KC> <LastModifiedDate>2024-09-22T17:06:58.5663219Z</LastModifiedDate> <LastSeenDate>2024-10-20T15:06:58.5663219Z</LastSeenDate> <MachineID>725cecb909c44174ab8c407f1be77c29725cecb909c44174ab8c407f1be77c29:::0968f926072c4cd080660968f926072c4cd08066:::0968f926072c4cd080660968f926072c4cd08066</MachineID> <MasterKC>5311-63A0-0FF9-4713-B2A1</MasterKC> <TrafficCountLast24Hours>2134</TrafficCountLast24Hours> <UninstalledDate i:nil="true" /> </DNSPEndpointInfo> <DNSPEndpointInfo> <AgentVersion>1.3.3.35</AgentVersion> <DNSAgentStatus>Installed</DNSAgentStatus> <DNSPolicyID>a322451f-d3ec-4b25-ac46-96fb0701ecb3</DNSPolicyID> <DNSPolicyName>Securedns High Protection</DNSPolicyName> <HostName>Computer2</HostName> <InstalledDate>2024-08-22T15:06:58.5663219Z</InstalledDate> <IsVirtualMachine>false</IsVirtualMachine> <KC>8436-D3F9-0E16-4722-B6D6</KC> <LastModifiedDate>2024-08-22T19:06:58.5663219Z</LastModifiedDate> <LastSeenDate>2024-10-18T15:06:58.5663219Z</LastSeenDate> <MachineID>f0b7fcea0b7f4330a8573e1012eb0918f0b7fcea0b7f4330a8573e1012eb0918:::9e2bcf223ba041c295bc9e2bcf223ba041c295bc:::9e2bcf223ba041c295bc9e2bcf223ba041c295bc</MachineID> <MasterKC>5311-63A0-0FF9-4713-B2A1</MasterKC> <TrafficCountLast24Hours>2134</TrafficCountLast24Hours> <UninstalledDate i:nil="true" /> </DNSPEndpointInfo> </QueryResults> </DNSPAgentStatus>