Legacy Umbrella API key authentication

Authentication

To get started, log in to Umbrella and create your Umbrella Management, Umbrella Network Devices, Legacy Network Devices, and Umbrella Reporting API keys.

Note: API keys, passwords, secrets, and encoded strings allow access to your private customer data. You should never share your credentials with another user or organization.

Prerequisites

Log in to Umbrella

Log in to Umbrella with the following URL:

https://dashboard.umbrella.com

In Umbrella, you can find your username after Admin in the navigation tree. Confirm that your organization appears under your username.

Create Legacy Umbrella API Key

Create a legacy Umbrella API key and secret.

Note: You have only one opportunity to copy your secret. Umbrella does not save your secret and it cannot be retrieved after its initial creation.
  1. Navigate to Admin > API Keys or in a Multi-Org, MSP, or MSSP console, navigate to Settings > API Keys.

  2. Click Legacy Keys.

    network devices API key
  3. Expand a legacy Umbrella API key, and click Generate Token.

    management API key
  4. Copy your Key and Secret.

  5. Click For security reasons, .... You must acknowledge that your key and secret are only displayed once to close the key.

    network devices API key acknowledgement

Refresh Legacy Umbrella API Key

Refresh a legacy Umbrella API key and secret.

Note: You have only one opportunity to copy your secret. Umbrella does not save your secret and it cannot be retrieved after its initial creation.
  1. Navigate to Admin > API Keys or in a Multi-Org, MSP, or MSSP console, navigate to Settings > API Keys.

  2. Click Legacy Keys.

    management API key
  3. Expand a legacy Umbrella API key, and click Refresh.

    management API key
  4. Click Refresh to confirm the rotation of your credentials.

    management API key
  5. Copy your Key and Secret.

  6. Click For security reasons, .... You must acknowledge that your key and secret are only displayed once to close the key.

    management API key acknowledgement

Delete Legacy Umbrella API Key

Delete a legacy Umbrella API key and secret.

  1. Navigate to Admin > API Keys or in a Multi-Org, MSP, or MSSP console, navigate to Settings > API Keys.

  2. Click Legacy Keys.

    network devices API key
  3. Expand an Umbrella Management, Umbrella Network Devices, or Umbrella Reporting key, and click Delete.

  4. Click Delete to confirm the removal of your key.

    network devices API key