The OpenDNS Network Devices API Developer Hub

Welcome to the OpenDNS Network Devices API developer hub. You'll find comprehensive guides and documentation to help you start working with OpenDNS Network Devices API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Identifying DNS traffic

After a successful registration, the device will receive a Device ID. This should be added to the DNS packet to create an EDNS0 packet. The format of EDNS0 packets is specified by RFC2671, with some specifics below.

The only information that is required on the device is the Device ID. The registration can be done through a separate configuration utility using the device’s details (model, MAC address, label, and serial number). The resulting Device ID can then be passed to the device for future use. If the device is doing the registration, each device also needs the API key and API token. The API key can be set for all devices, but the API token needs to be obtained from the specific customer dashboard and transferred to each device.

OPT RR description

Field
Type
Description

Name

Domain Name

Empty (root domain, 0)

Type

u_int16

OPT (41)

Class

u_int16

Sender’s UDP payload size (default 512; Umbrella supports up to 4096)

TTL

u_int32

Extended RCODE and flags (default 0)

RDLEN

u_int16

Combined size in bytes of RDATA options

RDATA

octet stream

One or two RDATA options, formatted in {attribute,value} pairs

RDATA description

Field
Type
Description

OPTION-CODE

u_int16

0x6942 (hex) or 26946 (decimal)

OPTION-LENGTH

u_int16

Size in octets of OPTION-DATA (15 bytes)

OPTION-DATA

octet stream

Data (“OpenDNS” + 8 octets of Device ID)

If the Device ID returned from the Register call is “0123456789abcdef”, RDATA would consist of the following array of bytes:

[ 0x69, 0x42, 0x00, 0x0F, 0x4F, 0x70, 0x65, 0x6E, 0x44, 0x4E, 0x53, 0x01, 0x23, 0x45, 0x67, 0x89, 0xAB, 0xCD, 0xEF ]

Remote IP address information

To embed remote IP address information, please use the Network Device Management Identifying DNS Traffic EDNS option instead.


Registration API Endpoint < Identifying DNS Traffic

Updated 4 months ago

Identifying DNS traffic


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.