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-04-30T17:05:57.3507292Z", "UninstalledDate": null, "AgentVersion": "1.3.3.35", "LastSeenDate": "2025-05-28T17:05:57.3507292Z", "LastModifiedDate": "2025-04-30T19:05:57.3507292Z", "TrafficCountLast24Hours": 2134, "DNSPolicyID": "96a145d7-c7e6-4a56-8a32-0a46a6d696da", "DNSPolicyName": "Securedns High Protection", "MachineID": "be958105201648b3b3f7d86fd75bf782be958105201648b3b3f7d86fd75bf782:::f49f57f0f7694cca83aaf49f57f0f7694cca83aa:::f49f57f0f7694cca83aaf49f57f0f7694cca83aa", "KC": "DEA5-6992-9C34-43AE-8537", "MasterKC": "4678-0077-D1A9-4200-9D9D" }, { "HostName": "Computer2", "IsVirtualMachine": false, "DNSAgentStatus": "Installed", "InstalledDate": "2025-03-30T17:05:57.3507292Z", "UninstalledDate": null, "AgentVersion": "1.3.3.35", "LastSeenDate": "2025-05-26T17:05:57.3507292Z", "LastModifiedDate": "2025-03-30T21:05:57.3507292Z", "TrafficCountLast24Hours": 2134, "DNSPolicyID": "0a14ca36-5eda-4c21-b052-e293ef9b9e06", "DNSPolicyName": "Securedns High Protection", "MachineID": "595fc57669194422b360fb5e9055c29e595fc57669194422b360fb5e9055c29e:::42d70691cf5b4305bbc542d70691cf5b4305bbc5:::42d70691cf5b4305bbc542d70691cf5b4305bbc5", "KC": "DEA5-6992-9C34-43AE-8537", "MasterKC": "4678-0077-D1A9-4200-9D9D" } ], "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>96a145d7-c7e6-4a56-8a32-0a46a6d696da</DNSPolicyID> <DNSPolicyName>Securedns High Protection</DNSPolicyName> <HostName>Computer1</HostName> <InstalledDate>2025-04-30T17:05:57.3507292Z</InstalledDate> <IsVirtualMachine>false</IsVirtualMachine> <KC>DEA5-6992-9C34-43AE-8537</KC> <LastModifiedDate>2025-04-30T19:05:57.3507292Z</LastModifiedDate> <LastSeenDate>2025-05-28T17:05:57.3507292Z</LastSeenDate> <MachineID>be958105201648b3b3f7d86fd75bf782be958105201648b3b3f7d86fd75bf782:::f49f57f0f7694cca83aaf49f57f0f7694cca83aa:::f49f57f0f7694cca83aaf49f57f0f7694cca83aa</MachineID> <MasterKC>4678-0077-D1A9-4200-9D9D</MasterKC> <TrafficCountLast24Hours>2134</TrafficCountLast24Hours> <UninstalledDate i:nil="true" /> </DNSPEndpointInfo> <DNSPEndpointInfo> <AgentVersion>1.3.3.35</AgentVersion> <DNSAgentStatus>Installed</DNSAgentStatus> <DNSPolicyID>0a14ca36-5eda-4c21-b052-e293ef9b9e06</DNSPolicyID> <DNSPolicyName>Securedns High Protection</DNSPolicyName> <HostName>Computer2</HostName> <InstalledDate>2025-03-30T17:05:57.3507292Z</InstalledDate> <IsVirtualMachine>false</IsVirtualMachine> <KC>DEA5-6992-9C34-43AE-8537</KC> <LastModifiedDate>2025-03-30T21:05:57.3507292Z</LastModifiedDate> <LastSeenDate>2025-05-26T17:05:57.3507292Z</LastSeenDate> <MachineID>595fc57669194422b360fb5e9055c29e595fc57669194422b360fb5e9055c29e:::42d70691cf5b4305bbc542d70691cf5b4305bbc5:::42d70691cf5b4305bbc542d70691cf5b4305bbc5</MachineID> <MasterKC>4678-0077-D1A9-4200-9D9D</MasterKC> <TrafficCountLast24Hours>2134</TrafficCountLast24Hours> <UninstalledDate i:nil="true" /> </DNSPEndpointInfo> </QueryResults> </DNSPAgentStatus>