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
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": "2025-03-19T01:21:34.8605338Z", "UninstalledDate": null, "AgentVersion": "1.3.3.35", "LastSeenDate": "2025-04-17T01:21:34.8605338Z", "LastModifiedDate": "2025-03-19T03:21:34.8605338Z", "TrafficCountLast24Hours": 2134, "DNSPolicyID": "deae17c4-cf34-48f9-8a26-52f8860f676b", "DNSPolicyName": "Securedns High Protection", "MachineID": "7e07d4b04e86454c8cb5d3267488ede47e07d4b04e86454c8cb5d3267488ede4:::60aa6efb86e94adca78d60aa6efb86e94adca78d:::60aa6efb86e94adca78d60aa6efb86e94adca78d", "KC": "1FA9-3D80-D756-4F02-A923", "MasterKC": "F9C7-2134-EA0F-4E27-B758" }, { "HostName": "Computer2", "IsVirtualMachine": false, "DNSAgentStatus": "Installed", "InstalledDate": "2025-02-19T01:21:34.8605338Z", "UninstalledDate": null, "AgentVersion": "1.3.3.35", "LastSeenDate": "2025-04-15T01:21:34.8605338Z", "LastModifiedDate": "2025-02-19T05:21:34.8605338Z", "TrafficCountLast24Hours": 2134, "DNSPolicyID": "6731a600-a1c2-493a-a6da-33d1dea86d50", "DNSPolicyName": "Securedns High Protection", "MachineID": "18af5ee526dd4d6296daa1429157e70f18af5ee526dd4d6296daa1429157e70f:::351d70ff7fc348cca286351d70ff7fc348cca286:::351d70ff7fc348cca286351d70ff7fc348cca286", "KC": "1FA9-3D80-D756-4F02-A923", "MasterKC": "F9C7-2134-EA0F-4E27-B758" } ], "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>deae17c4-cf34-48f9-8a26-52f8860f676b</DNSPolicyID> <DNSPolicyName>Securedns High Protection</DNSPolicyName> <HostName>Computer1</HostName> <InstalledDate>2025-03-19T01:21:34.8605338Z</InstalledDate> <IsVirtualMachine>false</IsVirtualMachine> <KC>1FA9-3D80-D756-4F02-A923</KC> <LastModifiedDate>2025-03-19T03:21:34.8605338Z</LastModifiedDate> <LastSeenDate>2025-04-17T01:21:34.8605338Z</LastSeenDate> <MachineID>7e07d4b04e86454c8cb5d3267488ede47e07d4b04e86454c8cb5d3267488ede4:::60aa6efb86e94adca78d60aa6efb86e94adca78d:::60aa6efb86e94adca78d60aa6efb86e94adca78d</MachineID> <MasterKC>F9C7-2134-EA0F-4E27-B758</MasterKC> <TrafficCountLast24Hours>2134</TrafficCountLast24Hours> <UninstalledDate i:nil="true" /> </DNSPEndpointInfo> <DNSPEndpointInfo> <AgentVersion>1.3.3.35</AgentVersion> <DNSAgentStatus>Installed</DNSAgentStatus> <DNSPolicyID>6731a600-a1c2-493a-a6da-33d1dea86d50</DNSPolicyID> <DNSPolicyName>Securedns High Protection</DNSPolicyName> <HostName>Computer2</HostName> <InstalledDate>2025-02-19T01:21:34.8605338Z</InstalledDate> <IsVirtualMachine>false</IsVirtualMachine> <KC>1FA9-3D80-D756-4F02-A923</KC> <LastModifiedDate>2025-02-19T05:21:34.8605338Z</LastModifiedDate> <LastSeenDate>2025-04-15T01:21:34.8605338Z</LastSeenDate> <MachineID>18af5ee526dd4d6296daa1429157e70f18af5ee526dd4d6296daa1429157e70f:::351d70ff7fc348cca286351d70ff7fc348cca286:::351d70ff7fc348cca286351d70ff7fc348cca286</MachineID> <MasterKC>F9C7-2134-EA0F-4E27-B758</MasterKC> <TrafficCountLast24Hours>2134</TrafficCountLast24Hours> <UninstalledDate i:nil="true" /> </DNSPEndpointInfo> </QueryResults> </DNSPAgentStatus>