Guides
ProductDeveloperPartnerPersonal
Guides
ProductDeveloperPartnerPersonal

Manage KeyAdmin API Keys

The Umbrella KeyAdmin API enables you to programmatically create and manage Umbrella API keys. With your KeyAdmin API key credentials, you can generate an Umbrella API access token, and then use your token to create and manage your Umbrella API keys.

For more information, see Umbrella API Authentication.

You can create any number of KeyAdmin API keys. When you create an API key, choose the permissions for each key and optionally select an expiration date. If you do not set an expiration date for your key, your KeyAdmin API key is set to never expire.

Table of Contents

Prerequisites

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

Add KeyAdmin API Key

  1. Navigate to Admin > API Keys.
  2. Click KeyAdmin 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.
2270
  1. Enter a name for the key and optional Description. A name must contain less than 256 characters.
2132
  1. Select the permissions for the key.
2126
  1. For Expiry Date, choose the expiration date for the key, or choose Never expire.
2130

  1. (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.

  2. Click Create Key.

  3. Copy and save your KeyAdmin Key and Key Secret.

  4. Click Accept and Close.

2030

Refresh KeyAdmin API Key

  1. Navigate to Admin > API Keys.
  2. Click KeyAdmin Keys, and then expand an API key.
2270
  1. Click Refresh Key.
2402
  1. Copy and save your KeyAdmin Key and Key Secret.
  2. Click Accept and Close.
2030

Update KeyAdmin API Key

  1. Navigate to Admin > API Keys.
  2. Click KeyAdmin Keys, and then expand an API key. You can modify the KeyAdmin Key Name, Description, Permissions, and Expiry Date.
2130

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

  2. Click Save.

Delete KeyAdmin API Key

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

Manage Static API Keys < Manage KeyAdmin API Keys > Manage Your Logs

Updated 5 months ago