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    

Authentication Key Generation

Authentication and Key Management for Umbrella APIs

Umbrella APIs use slightly different authentication methods, but all rely on generating a key and secret in the Umbrella Dashboard. Follow the instructions matching your organizational role:

Single-Org API Key Generation

  1. Navigate to Admin > API Keys​ and click Create.
  1. Select the appropriate API and click Create.
    Note: A grey radio button indicates that this API is unavailable.
  1. Expand the API entry, copy Your Key and, if available, Your Secret, check To keep it secure, ... and then click Close.
    You must acknowledge that your key and secret are only displayed once to activate the Close button.
    Note: You have only one opportunity to copy Your Secret. Umbrella does not save it and it cannot be retrieved after its initial creation.

To generate a new key and secret, click Refresh or Delete and then click Create.

Multi-org API Key Generation

  1. In your management console, navigate to Settings > API Keys, then click Create API Key.
    If you cannot access this page, it means the API Keys feature has not been enabled for your account. Contact [email protected] or your Umbrella account representative.
  1. Select Umbrella Management, then click Create.
  1. Copy your information to a safe location (you can't access it again), then click Close.
    Tip: "Refresh" invalidates any key created previously and generates a new one.

Endpoints by Authentication Type

Refer to the following table to determine which Umbrella authentication method is needed for a given Umbrella API endpoint:

Category Endpoint Authentication
Umbrella Management API /organizations Network Devices key & secret
Umbrella Management API /networkdevices Network Devices key & secret
Umbrella Management API /policies Network Devices key & secret
Reporting API v1 /activity Reporting API key & secret
Reporting API v1 /requests Reporting API key & secret
Reporting API v1 /identities Reporting API key & secret
Reporting API v2 various endpoints Reporting API key & secret
Console Reporting API /security-summary Console key & secret
Console Reporting API /detailed-summary Console key & secret
Legacy Netwk Devices API various endpoints Legacy Network Devices token
All Others various endpoints Umbrella Management key & secret

Updated about a month ago

Authentication Key Generation


Suggested Edits are limited on API Reference Pages

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