/v3/api/dnsQueryLogs/{queryId} (GET) - BlueCat DNS Edge

DNS Edge API Guide

prodname
BlueCat DNS Edge

Returns details for a specific query.

GET https://api-<DNS.Edge.URL>/v3/api/dnsQueryLogs/{queryId}
Authorization: Bearer token

Successful response

200 OK
Content-Type: application/JSON
[
  {
    "time":1588863296043,
    "source":"197.210.227.230",
    "siteId":"91d9e73b-c5ce-4f92-a419-5d421e8fef25",
    "query":"VERSION.BIND.",
    "queryType":"TXT",
    "actionTaken":"query-response",
    "response":"NOERROR",
    "id":"1588863296043BF913F410812953C6909E622C4702754",
    "matchedPolicies": [
    ],
    "answers": [
        {
            "domainName":"VERSION.BIND.",
            "recordType":"TXT",
            "parsed":true,
            "rData":"1.0.0"
        }
    ],
    "authority":[
    ],
    "queryProtocol":"UDP",
    "threats":[
    ],
    "queriedNamespaces":[
        {
            "id":"9bba84cc-00eb-4a6a-985b-b9cadb9de93a",
            "name":"Umbrella"
        },
      ....
    ],
    "latency":0
 }

Returns the following information:

  • Time: Unix time (in milliseconds) when the DNS query was made. (This is the request time, not the response time or logging time.)
  • Source: The IP address of the client making the DNS query.
  • Site: The site name of the service point handling the query.
  • Query: The domain name being queried.
  • QueryType: The query type.
  • Response: The response code (for example NXDOMAIN, NOERROR or SERVFAIL).
  • ID: An identifier that can be passed to key in subsequent requests (used for paging through lots of data)
  • Action Taken: If no policy was matched, this will be "query-response", otherwise this will be either block,redirect, or monitor
  • Matched Policies: List of policy IDs and names that matched the given query

    The number of entries in the list depends on the number of queries within specified period. The list returned may be empty.

  • Authority: The authority assigned to the DNS query.
  • QueryProtocol: The protocol of the DNS query (usually UDP or TCP).
  • Threats: The list of possible threats detected during the query analysis.
  • QueriedNamespaces: The list of namespaces the DNS query was queried against.
  • Latency: The latency (in milliseconds) of the DNS query measured.

Possible error codes

  • NOT_FOUND
  • UNEXPECTED_ERROR