Cisco-Umbrella-API-v2-Demo-DevNet

This is a basic application that shows multiple DNS graphs based on your Umbrella organization events.

The scope of this application is show case some of Cisco Umbrella Reporting API v2 related to DNS events only, these graphs are as follow:

  • Top Identities Allowed & Blocked events
  • Top Content Categories
  • Requests by timerange
  • Content Categories by timerange
  • Applications & lists per timerange
  • Security Settings per timerange

published

Contacts

Installation/Modification:

The application is hosted on appsmith platform.
appsmith is an Open-source, low-code platform to Build, ship, and maintain CRUD apps

A demo version of the application can be accessed by clicking on VIEW APPLICATION below


If you would like to modify the application and add further graphs consider registering in appsmith platform and import Cisco Umbrella API v2 Demo.json as an application

Once imported, you can start modifying the application and adding your own graphs and deploying it to start using the application.

Usage

The online application that is ready to be used, can be accessed by clicking here

The landing page is the login page, where you need to provide your Umbrella ORG ID, Reporting Key, and Reporting API Secret.

How to get Cisco Umbrella ORG ID can be found here

How to generate Umbrella Reporting key and secret can be found here, below are the steps:

  • Log into Umbrella and create a key and secret
  • In Umbrella, navigate to Admin > API Keys and click Create;
    or in a management console (Multi-org, MSP, or MSSP), navigate to Settings > API Keys and click Add.
  • Select Umbrella Reporting and click Generate Token.
  • Expand Umbrella Reporting and copy Your Key and Your Secret.
  • Click To keep it secure, ... check box and then click Close.

Upon providing them click submit

You will be provided by the dashboard that contains the following graphs:

  • Top Identities Allowed & Blocked events

  • Top Content Categories

  • Requests by timerange

  • Content Categories by timerange

  • Applications & lists per timerange

  • Security Settings per timerange

Disclaimer

Upon providing your Cisco Umbrella reporting key id and secret, please be aware that these credentials are going to some sort of backend hosted in appsmith instances.

As mentioned in Appsmith's documentations

 The Appsmith's backend system doesn't store any information related to the inputs
 made by users using an app or the responses of the queries. It acts as a pure 
 proxy system. It ensures that any private/confidential data is never logged or stored 
 in Appsmith's data stores. Appsmith stores the configuration of the queries so that 
 the SQL query body or custom API URLs are never exposed to the client in "view" 
 mode. Thus protecting the application as viewers cannot deduce the executed query.

If you are still concerned about the confidentiality of your credentials consider creating a hosted on-prem containerized instance of Appsmith and import your applications there.

Further resources on how to create containerized version of appsmith can be found here

Links to DevNet Learning Labs

For more resources on Umbrella API's you may refer to the following learning labs:

License

This source code is provided under Cisco Sample Code License, Version 1.1 License, for details see Cisco Sample Code License, Version 1.1

View code on GitHub
  • Owner

  • Contributors

    +2Github contributors
  • Categories

  • Products

    Umbrella
  • Programming Languages

  • License

    Other

Code Exchange Community

Get help, share code, and collaborate with other developers in the Code Exchange community.View Community
Disclaimer:
Cisco provides Code Exchange for convenience and informational purposes only, with no support of any kind. This page contains information and links from third-party websites that are governed by their own separate terms. Reference to a project or contributor on this page does not imply any affiliation with or endorsement by Cisco.