The Umbrella Deployment Documentation Developer Hub

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

Get Started    

Deployment Status Report

The Centralized Reports > Deployment Status report provides you with an overview of the total number of networks, Umbrella roaming clients, and VAs for your organization base.

You can search for a specific​ organization and when it is found overview information updates so that it is specific to that organization. Sortable columns allow you to find the key statistics you're most interested in.

For each organization, any inactive or unhealthy items are highlighted in yellow and can be selected, at which point you'll jump to the organization's Umbrella dashboard with a focused view on exactly which components are inactive. Unhealthy means the VA needs some kind of attention—it may not be sending traffic, the DNS isn't encrypted, or that there is only one and it can't properly update.

In the example below, if you were to click on the yellow bubble for 5 Inactive Roaming Clients, you'd be taken to a view showing only those inactive clients on the customer's Umbrella dashboard.

Note: The inactive report is time dependent. In the example of an Inactive Roaming Client, the Umbrella roaming client is set to inactive when it has sent zero DNS queries to Umbrella within the time period specified for the report. In the example of an inactive network, the network is set to inactive when the network has sent zero DNS queries to Umbrella within the time period specified for the report.


Overview Report < Deployment Status Report > Security Summary Report

Deployment Status Report


Suggested Edits are limited on API Reference Pages

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