Add Umbrella API Keys

The Umbrella API enables you to programmatically manage and protect your networks, tunnels, network entities, and users. You can manage access to destinations, view and update policies, and gain insight into your security events through Umbrella reports. Use your Umbrella API key and secret to generate an Umbrella access token. Then include your token in a request to the Umbrella API. For more information, see Umbrella API Authentication.

You can create any number of granular, multi-scoped Umbrella API keys and set an expiration date for your API key. If you do not choose an API key expiration date, your API key is set to never expire. You control how an Umbrella API key can access the Umbrella resources. An API key can only access the API resources found in the API key scopes. For each scope and resource, choose Read-Only or Read/Write access.

Table of Contents

• Prerequisites
• Add API Key
• Refresh API Key
• Update API Key
• Delete API Key

Prerequisites

• You must have Full Admin access to create and manage Umbrella API keys.

Add API Key

1. Navigate to Admin > API Keys.
2. Click API Keys and then click Add.
   The number of expired API keys appears next to the red triangle. The number of API keys that expire within 30 days appears next to the yellow triangle.

3. Enter a name for the key and add an optional Description. A name must contain less than 256 characters.

4. Select the key scopes and expand a key scope to view the resources. Check each resource in a key scope to enable access to the resource.

5. Choose Read-Only or Read/Write for the selected scope and resource.

6. For Expiry Date, choose an expiration date or choose Never expire.

7. (Optional) For Network Restrictions, enter a comma-separated list of public IP addresses or CIDRs, then click Add.

   Note: You can add up to ten networks to your API key. You can only use your API key to authenticate requests for clients on the selected networks. Click on the X to remove a network address.

   

8. Click Create Key.

9. Copy and save your API Key and Key Secret.

10. Click Accept and Close.

Refresh API Key

1. Navigate to Admin > API Keys.
2. Click API Keys, and then expand an API key.
3. Click Refresh Key.

4. Copy and save your API Key and Key Secret.
5. Click Accept and Close.

Update API Key

1. Navigate to Admin > API Keys.

2. Click API Keys, and then expand an API key.

3. Modify the API Key Name, Description, selected scopes in Key Scope, and Expiry Date.

   

4. For Network Restrictions, update the list of IP addresses and CIDRs. Click on the X to remove a network address.

   

5. Click Save.

Delete API Key

1. Navigate to Admin > API Keys.
2. Click API Keys, and then expand an API key.
3. Click Delete. In the dialog window, click Delete or Cancel.

---

Manage API Keys < Add Umbrella API Keys > Add Umbrella Legacy API Keys