DnsServerMeasurement - ThousandEyes API v7

{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/2cabdc9a06013343df12ec6445cac4b1398af4a3/beddd583-a5f3-3bb9-82a3-77fa650e7a7a","info":{"version":"7.0.97","title":"Test Results API","description":"Get test result metrics for Network and Application Synthetics tests."},"security":[{"BearerAuth":[]}],"tags":[{"name":"Network Test Results"},{"name":"Web HTTP Server Test Results"},{"name":"Web Page Load Test Results"},{"name":"Web Transactions Test Results"},{"name":"API Test Results"},{"name":"Web FTP Server Test Results"},{"name":"DNS Trace Test Results"},{"name":"DNS Server Test Results"},{"name":"DNSSEC Test Results"},{"name":"Voice SIP Server Test Results"},{"name":"Voice RTP Server Test Results"},{"name":"Network BGP Test Results"}],"externalDocs":{"description":"Find out more about Test Results","url":"https://docs.thousandeyes.com/product-documentation/getting-started/getting-started-with-cloud-and-enterprise-agent-tests#interpreting-test-results"},"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Bearer authentication token"}}},"spec":{"type":"object","description":"DNS resolution details collected while locating the HTTP test target. Present when the agent captured DNS server measurement data for the round. The order of `unusedDnsResponses` matches the order returned by the DNS resolver.","readOnly":true,"properties":{"usedDnsResponse":{"type":"object","description":"A DNS response received while resolving the HTTP test target.","readOnly":true,"properties":{"id":{"type":"integer","description":"DNS message ID.","example":41837,"readOnly":true},"qr":{"type":"string","description":"DNS header QR flag.","enum":["query","response"],"example":"response","readOnly":true,"$$ref":"#/components/schemas/DnsQr"},"opcode":{"type":"string","description":"DNS header OPCODE field (RFC 1035).","enum":["query","iquery","status","unknown-3","unknown-4","unknown-5","unknown-6","unknown-7","unknown-8","unknown-9","unknown-10","unknown-11","unknown-12","unknown-13","unknown-14","unknown-15"],"example":"query","readOnly":true,"$$ref":"#/components/schemas/DnsOpcode"},"authoritativeAnswer":{"type":"boolean","description":"DNS header AA flag.","example":false,"readOnly":true},"truncation":{"type":"boolean","description":"DNS header TC flag.","example":false,"readOnly":true},"recursionDesired":{"type":"boolean","description":"DNS header RD flag.","example":true,"readOnly":true},"recursionAvailable":{"type":"boolean","description":"DNS header RA flag.","example":true,"readOnly":true},"zero":{"type":"boolean","description":"DNS header Z flag. Reserved and expected to be false.","example":false,"readOnly":true},"authenticData":{"type":"boolean","description":"DNS header AD flag.","example":false,"readOnly":true},"checkingDisabled":{"type":"boolean","description":"DNS header CD flag.","example":false,"readOnly":true},"responseCode":{"type":"string","description":"DNS response code (RCODE), including extended RCODE values (RFC 1035 and RFC 6891).","enum":["noerror","formerr","servfail","nxdomain","notimp","refused","yxdomain","yxrrset","nxrrset","notauth","notzone","unknown-11","unknown-12","unknown-13","unknown-14","unknown-15","badvers","badkey","badtime","badmode","badname","badalg","badtrunc","badcookie"],"example":"noerror","readOnly":true,"$$ref":"#/components/schemas/DnsResponseCode"},"question":{"type":"array","description":"Records in the DNS question section.","items":{"type":"object","description":"A DNS resource record from the question or answer section.","readOnly":true,"properties":{"name":{"type":"string","description":"Record name.","example":"www.google.com","readOnly":true},"type":{"type":"string","description":"DNS resource record type (IANA). Values match `DnsRecordType` on DNS Server test configuration where applicable.","enum":["unknown","a","cname","aaaa"],"example":"a","readOnly":true,"$$ref":"#/components/schemas/DnsResourceRecordType"},"class":{"type":"string","description":"DNS resource record class (IANA).","enum":["unknown","in"],"example":"in","readOnly":true,"$$ref":"#/components/schemas/DnsResourceRecordClass"},"ttl":{"type":"integer","description":"Time to live in seconds.","example":300,"readOnly":true},"data":{"type":"string","description":"Record data (RDATA).","example":"142.250.191.132","readOnly":true}},"$$ref":"#/components/schemas/DnsResourceRecord"}},"answer":{"type":"array","description":"Records in the DNS answer section.","items":{"type":"object","description":"A DNS resource record from the question or answer section.","readOnly":true,"properties":{"name":{"type":"string","description":"Record name.","example":"www.google.com","readOnly":true},"type":{"type":"string","description":"DNS resource record type (IANA). Values match `DnsRecordType` on DNS Server test configuration where applicable.","enum":["unknown","a","cname","aaaa"],"example":"a","readOnly":true,"$$ref":"#/components/schemas/DnsResourceRecordType"},"class":{"type":"string","description":"DNS resource record class (IANA).","enum":["unknown","in"],"example":"in","readOnly":true,"$$ref":"#/components/schemas/DnsResourceRecordClass"},"ttl":{"type":"integer","description":"Time to live in seconds.","example":300,"readOnly":true},"data":{"type":"string","description":"Record data (RDATA).","example":"142.250.191.132","readOnly":true}},"$$ref":"#/components/schemas/DnsResourceRecord"}},"dnsResolver":{"type":"string","description":"DNS resolver that returned this response.","example":"8.8.8.8","readOnly":true},"timing":{"type":"object","description":"Timing metrics for a DNS lookup.","readOnly":true,"properties":{"startTimeUs":{"type":"string","description":"Unix epoch timestamp in microseconds when the DNS query started.","example":"1769706600000000","readOnly":true},"totalTimeUs":{"type":"integer","description":"Total DNS lookup time in microseconds.","example":19304,"readOnly":true}},"$$ref":"#/components/schemas/DnsTiming"},"protocol":{"type":"string","description":"Actual wire transport used to perform the DNS lookup. `tcp` indicates a TCP retry (for example, after a truncated UDP response).","enum":["unspecified","udp","tcp","dot","doh"],"example":"udp","readOnly":true,"$$ref":"#/components/schemas/DnsMeasurementProtocol"}},"$$ref":"#/components/schemas/DnsServerResponse"},"unusedDnsResponses":{"type":"array","description":"Additional DNS responses received while resolving the target.","items":{"type":"object","description":"A DNS response received while resolving the HTTP test target.","readOnly":true,"properties":{"id":{"type":"integer","description":"DNS message ID.","example":41837,"readOnly":true},"qr":{"type":"string","description":"DNS header QR flag.","enum":["query","response"],"example":"response","readOnly":true,"$$ref":"#/components/schemas/DnsQr"},"opcode":{"type":"string","description":"DNS header OPCODE field (RFC 1035).","enum":["query","iquery","status","unknown-3","unknown-4","unknown-5","unknown-6","unknown-7","unknown-8","unknown-9","unknown-10","unknown-11","unknown-12","unknown-13","unknown-14","unknown-15"],"example":"query","readOnly":true,"$$ref":"#/components/schemas/DnsOpcode"},"authoritativeAnswer":{"type":"boolean","description":"DNS header AA flag.","example":false,"readOnly":true},"truncation":{"type":"boolean","description":"DNS header TC flag.","example":false,"readOnly":true},"recursionDesired":{"type":"boolean","description":"DNS header RD flag.","example":true,"readOnly":true},"recursionAvailable":{"type":"boolean","description":"DNS header RA flag.","example":true,"readOnly":true},"zero":{"type":"boolean","description":"DNS header Z flag. Reserved and expected to be false.","example":false,"readOnly":true},"authenticData":{"type":"boolean","description":"DNS header AD flag.","example":false,"readOnly":true},"checkingDisabled":{"type":"boolean","description":"DNS header CD flag.","example":false,"readOnly":true},"responseCode":{"type":"string","description":"DNS response code (RCODE), including extended RCODE values (RFC 1035 and RFC 6891).","enum":["noerror","formerr","servfail","nxdomain","notimp","refused","yxdomain","yxrrset","nxrrset","notauth","notzone","unknown-11","unknown-12","unknown-13","unknown-14","unknown-15","badvers","badkey","badtime","badmode","badname","badalg","badtrunc","badcookie"],"example":"noerror","readOnly":true,"$$ref":"#/components/schemas/DnsResponseCode"},"question":{"type":"array","description":"Records in the DNS question section.","items":{"type":"object","description":"A DNS resource record from the question or answer section.","readOnly":true,"properties":{"name":{"type":"string","description":"Record name.","example":"www.google.com","readOnly":true},"type":{"type":"string","description":"DNS resource record type (IANA). Values match `DnsRecordType` on DNS Server test configuration where applicable.","enum":["unknown","a","cname","aaaa"],"example":"a","readOnly":true,"$$ref":"#/components/schemas/DnsResourceRecordType"},"class":{"type":"string","description":"DNS resource record class (IANA).","enum":["unknown","in"],"example":"in","readOnly":true,"$$ref":"#/components/schemas/DnsResourceRecordClass"},"ttl":{"type":"integer","description":"Time to live in seconds.","example":300,"readOnly":true},"data":{"type":"string","description":"Record data (RDATA).","example":"142.250.191.132","readOnly":true}},"$$ref":"#/components/schemas/DnsResourceRecord"}},"answer":{"type":"array","description":"Records in the DNS answer section.","items":{"type":"object","description":"A DNS resource record from the question or answer section.","readOnly":true,"properties":{"name":{"type":"string","description":"Record name.","example":"www.google.com","readOnly":true},"type":{"type":"string","description":"DNS resource record type (IANA). Values match `DnsRecordType` on DNS Server test configuration where applicable.","enum":["unknown","a","cname","aaaa"],"example":"a","readOnly":true,"$$ref":"#/components/schemas/DnsResourceRecordType"},"class":{"type":"string","description":"DNS resource record class (IANA).","enum":["unknown","in"],"example":"in","readOnly":true,"$$ref":"#/components/schemas/DnsResourceRecordClass"},"ttl":{"type":"integer","description":"Time to live in seconds.","example":300,"readOnly":true},"data":{"type":"string","description":"Record data (RDATA).","example":"142.250.191.132","readOnly":true}},"$$ref":"#/components/schemas/DnsResourceRecord"}},"dnsResolver":{"type":"string","description":"DNS resolver that returned this response.","example":"8.8.8.8","readOnly":true},"timing":{"type":"object","description":"Timing metrics for a DNS lookup.","readOnly":true,"properties":{"startTimeUs":{"type":"string","description":"Unix epoch timestamp in microseconds when the DNS query started.","example":"1769706600000000","readOnly":true},"totalTimeUs":{"type":"integer","description":"Total DNS lookup time in microseconds.","example":19304,"readOnly":true}},"$$ref":"#/components/schemas/DnsTiming"},"protocol":{"type":"string","description":"Actual wire transport used to perform the DNS lookup. `tcp` indicates a TCP retry (for example, after a truncated UDP response).","enum":["unspecified","udp","tcp","dot","doh"],"example":"udp","readOnly":true,"$$ref":"#/components/schemas/DnsMeasurementProtocol"}},"$$ref":"#/components/schemas/DnsServerResponse"},"example":[{"id":41838,"responseCode":"servfail","dnsResolver":"8.8.4.4","question":[{"name":"www.google.com","type":"aaaa","class":"in","ttl":0,"data":""}]}]},"usedHostsFile":{"type":"boolean","description":"Indicates whether the hosts file (for example, `/etc/hosts`) was used to resolve the target.","example":false,"readOnly":true},"resolvedIp":{"type":"string","description":"IP address resolved for the target, from DNS or the hosts file.","example":"142.250.191.132","readOnly":true}},"$$ref":"#/components/schemas/DnsServerMeasurement","title":"DnsServerMeasurement"}}