Create API Keys

You can create an API key to authenticate and authorize access to specific applications, enforce role-based access control, and set policy expiry dates. After successfully creating a key, copy it to a secure location.

Complete the following to create an API key:

1. Go to Settings > User Management > API Keys.
2. Click Actions > Create New API Credential.
3. In the Details section, provide the following Information:
   • Name. Enter a name for the API key.
   • Description. Provide useful information to create the API key.
   • Expiration. Set an expiration date for the API key.
     
     
   • In the Notify by email when a key is nearing expiration section, turn on the toggle to receive alerts before the key expires.
     • Destination email Addresses. Enter the destination email address to receive alerts before the key expires.
     • Time before expiration to send Email. Select the time to send alerts before the key expires.
     • Frequency of notification. Select how far in advance the system should send alerts before the key expires.
        
   • In the Roles section, choose from the following role types: 
     • Administrator. Use this role to manage infrastructure-related features. After selecting, its child roles, such as Cloud Firewall and Setup Configuration, appear in the right panel. Select the required child roles and enable Read and Write permissions as needed.
       
       
     • Policy Management. Use this role to manage policy-related tasks. After selecting its child role, such as Classification, Cloud Firewall Policy, List Catalog, Feature Configuration, Private Access Policy, and Web Policy, appear in the right panel. Select the required child roles and enable Read and Write permissions as needed.
       
       
        
     • Usage Analytics Users. Use this role to manage reporting activities. After selecting its child role, usage analytics appears in the right panel. Select the child role and enable Read and Write permissions as needed.
       
       
     • Content Inspection. Use this role to manage inspection activities, such as submitting content for scanning via API. Similar to other roles like Administrator or Policy, Content Inspection defines permissions for content handling. This capability grants execution access and does not require separate Read or Write settings.
       
       
4. Click Save.
5. After saving, the API key is displayed in a dialog box. Use the icon () to copy the API key and use the icon () to view the API key.
   
   

6. The newly created API key will now appear in the API Keys page.