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

Overview

The Umbrella Management API enables direct customers, SPs, MSPs, and MSSPs to manage organizations, networks, network devices, users, and roaming computers, and integrate actions in those areas into your workflows.

The Management API is a REST API with JSON responses. All requests must include your API key and secret. To do that in cURL, use the -u option: -u 'key:secret'

For more information about authentication in Umbrella APIs, see:
About the Umbrella Console API endpoints.

For complete information about the Management API calls, see the API Reference.

1. To begin, generate an API key

Umbrella Dashboard: Navigate to Admin > API Keys, then click Add.

Management Consoles (Multi-org, MSP, MSSP): Navigate to Settings > API Keys, then click Add.

  1. In the What should this API do? modal, select "Umbrella Network Devices", "Legacy Network Devices", "Umbrella Reporting", or "Umbrella Management" as appropriate, then click Create.

Important

You have only one opportunity to copy the secret that is displayed next. Secrets are not stored within Umbrella and can not be resurfaced after the initial creation.

  1. The key and secret appear. Acknowledge that the secret can be seen only once by clicking the checkbox, then click Close.

Legacy API Token

If you selected Legacy Network Devices, you receive an API Token rather than a secret and key.

To generate a new key and secret, click the refresh button on your existing key and secret. Alternatively, delete the existing key and secret, then create a new key/secret pair.

Rate Limits

The Management API is rate limited. Rate limits are applied per individual API token, and consist of these caps:

  • 5 requests per second
  • 14 requests per minute
  • 350 requests per 30 minutes

When a rate limit is reached, the API will return the Too Many Requests error with the HTTP response code 429. For more information about error codes, see Authentication and Errors.

Data batch size

The API defaults to fetching lists of data in batches of 200.

Using the API

To review the available requests you can submit, refer to the API Reference.