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    

Overview

A network device identity is loosely defined as any hardware device that is able to route DNS traffic to the Cisco Umbrella recursive DNS servers. The first step is registering the device with Cisco Umbrella. Once the traffic from the device reaches the DNS servers, the organization with which the device is registered is identified and policies for that organization can be applied to the traffic.

The Network Devices API allows you to register network devices as identities to the Umbrella dashboard. Once the device is registered as an identity, you can use the API to add and remove the device from configured policies. Once registered, the device is automatically added to the default policy. You can also remove a policy from being applied to a device, with the exception of the default policy, which cannot be removed.

Authentication to the Umbrella Network Device API

Authentication for device management using the Umbrella API is handled like all other endpoints. For more information, see Authentication And Errors.

Identifying the Organization to register the Network Device with

All Umbrella identity management requires the organization be specified, then in order to apply a policy to a device, you first need a list of the polices for the organization. That can be gathered using GET.

Network Devices API endpoints

Once you have a list of the policyIds and the organizationId, you can begin to create and modify network device identities and apply policies to each of them. The first step is to register (create) a network device. For more information, see Register (Create) A Device.

Overview


Suggested Edits are limited on API Reference Pages

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