> ## Documentation Index
> Fetch the complete documentation index at: https://docs.threataware.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Cisco Umbrella

> Connect ThreatAware to Cisco Umbrella to monitor DNS security and web filtering

## Overview

The Cisco Umbrella integration enables ThreatAware to collect DNS security and web filtering data from your Cisco Umbrella deployment, providing visibility into network security across your organisation.

<Info>
  **Connection Method**: API
  **Setup Time**: 15 minutes
  **Access Required**: Cisco Umbrella Administrator account
</Info>

## Data collected

The Cisco Umbrella integration provides:

* DNS security events
* Web filtering and blocking events
* Network traffic patterns
* Security threat data
* Compliance metrics

## Use cases

<CardGroup cols={2}>
  <Card title="DNS Security Monitoring" icon="shield-halved">
    Monitor DNS security events and threat detection
  </Card>

  <Card title="Web Filtering Tracking" icon="globe">
    Track web filtering policies and blocked threats
  </Card>

  <Card title="Network Threat Detection" icon="triangle-exclamation">
    Detect malware, botnets, and command & control traffic
  </Card>

  <Card title="Security Analytics" icon="bar-chart">
    Analyze network security trends and patterns
  </Card>
</CardGroup>

## Setup instructions

<Steps>
  <Step title="Log in to Cisco Umbrella Console">
    Access the [Cisco Umbrella Dashboard](https://login.umbrella.com/) with an administrator account.
  </Step>

  <Step title="Navigate to API Key Settings">
    In the Cisco Umbrella console:

    * Go to **Admin** > **API Keys**
    * This is where you'll create your API credentials
  </Step>

  <Step title="Create an API Key">
    Click **Create** to generate a new API key for ThreatAware integration.

    * The system will generate an API **Key** and **Secret**
    * Copy both the **Key** and **Secret** and store them securely

    <Warning>
      The Secret will only be displayed once. Copy both values immediately and store them securely.
    </Warning>
  </Step>

  <Step title="Enter Credentials in ThreatAware">
    In ThreatAware:

    * Navigate to **Settings** > **Integrations**
    * Search for and select **Cisco Umbrella**
    * Enter the required credentials:
      * **API Key**: The key you copied from Cisco Umbrella
      * **API Secret**: The secret you copied from Cisco Umbrella
  </Step>

  <Step title="Connect and Verify">
    Click **Connect** to establish the integration.

    Verify the connection status shows **Active** in ThreatAware.
  </Step>
</Steps>

## Required credentials

<AccordionGroup>
  <Accordion title="API Key" icon="key">
    **Field Name**: Cisco Umbrella API Key
    **Type**: String
    **Description**: The API key generated in Cisco Umbrella for integration access

    <Tip>
      Store this credential securely in your organisation's password manager.
    </Tip>
  </Accordion>

  <Accordion title="API Secret" icon="lock">
    **Field Name**: Cisco Umbrella API Secret
    **Type**: Password (encrypted)
    **Description**: The secret associated with the API Key

    <Warning>
      The Secret will only be displayed once during creation. Copy it immediately and store it securely.
    </Warning>
  </Accordion>
</AccordionGroup>

## Verification and testing

After setup, verify the integration is working correctly:

1. **Check Integration Status**
   * Navigate to **Settings** > **Integrations** in ThreatAware
   * Confirm the Cisco Umbrella integration shows **Active** status

2. **Verify Data Collection**
   * Wait up to 1 hour for the initial data sync
   * Check that Cisco Umbrella DNS security data appears
   * Verify network traffic and threat detection events are visible

3. **Test Queries**
   * Create a test query to filter by DNS security events
   * Verify network traffic data matches your Umbrella environment
   * Test filtering by threat type or blocking status

## Troubleshooting

<AccordionGroup>
  <Accordion title="Invalid Credentials" icon="triangle-exclamation">
    **Symptoms**: Connection fails with authentication error

    **Solutions**:

    * Verify the **API Key** and **API Secret** are entered correctly
    * Ensure both values were copied completely without extra spaces
    * Check that the credentials have not expired
    * Regenerate API credentials if needed
  </Accordion>

  <Accordion title="Permission Denied" icon="ban">
    **Symptoms**: Connection succeeds but no data appears or permission errors occur

    **Solutions**:

    * Verify the API key has read permissions to:
      * DNS security data
      * Web filtering events
      * Network traffic data
    * Review the [Cisco Umbrella API Documentation](https://developer.cisco.com/docs/umbrella/) for required permissions
    * Check API key scope and permissions in Cisco Umbrella
  </Accordion>

  <Accordion title="Connection Timeout" icon="clock">
    **Symptoms**: Integration fails to connect or times out

    **Solutions**:

    * Verify the Cisco Umbrella service is online and accessible
    * Check firewall rules allow outbound HTTPS access to Cisco Umbrella
    * Test connectivity to the Umbrella API endpoint
    * Contact Cisco support if service issues persist
  </Accordion>

  <Accordion title="No Data Appearing" icon="database">
    **Symptoms**: Integration shows active but no Umbrella data appears

    **Solutions**:

    * Verify there is DNS and traffic data in Cisco Umbrella to collect
    * Check the API credentials have sufficient permissions
    * Wait up to 1 hour for the initial data sync
    * Review ThreatAware integration logs for errors
    * Verify your Umbrella organisation has active monitoring
  </Accordion>
</AccordionGroup>

## Additional resources

<CardGroup cols={2}>
  <Card title="Cisco Umbrella API Documentation" icon="book" href="https://developer.cisco.com/docs/umbrella/">
    Official Cisco Umbrella API documentation for detailed configuration and permissions
  </Card>

  <Card title="ThreatAware Support" icon="life-ring" href="mailto:help@threataware.com">
    Contact ThreatAware support for integration assistance
  </Card>
</CardGroup>

## Best practices

<Tip>
  **Credential Management**

  * Generate a dedicated API key pair specifically for ThreatAware
  * Store credentials securely in your organisation's password manager
  * Rotate API credentials annually or per your security policy
  * Monitor for authentication failures in ThreatAware logs
</Tip>

<Tip>
  **Security Considerations**

  * Only grant read permissions to the API key
  * Limit API key scope to necessary data endpoints
  * Review Cisco Umbrella audit logs periodically to monitor API usage
  * Follow your organisation's least privilege principles
</Tip>