Umbrella DNS Python API Docs | dltHub

Cisco Umbrella provides a suite of APIs for cloud security, including reporting, investigation, and policy management capabilities. The REST API base URL is https://api.umbrella.com and OAuth 2.0 client credentials flow requiring Bearer token in the Authorization header..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv add "dlt[hub]" and start loading Umbrella DNS data in under 10 minutes.

---

What data can I load from Umbrella DNS?

Here are some of the endpoints you can load from Umbrella DNS:

---

How do I authenticate with the Umbrella DNS API?

The service uses the OAuth 2.0 Client Credentials Flow to generate access tokens. Requests to API endpoints require an 'Authorization' header with a value of 'Bearer <access_token>', and for POST/PUT/PATCH requests, a 'Content-Type' header of 'application/json' is required.

1. Get your credentials

1. Log in to the Cisco Umbrella dashboard. 2. Navigate to Admin > API Keys (or Console Settings > API Keys in multi-org/MSP/MSSP environments). 3. Click Add to create a new key. 4. Select the desired key scopes and provide a name. 5. Click Create Key. 6. Copy and store the API Key (Client ID) and Key Secret (Client Secret) immediately; they are only displayed once.

2. Add them to .dlt/secrets.toml

Copy
[sources.umbrella_dns_source]
api_key = "REPLACE_ME"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Umbrella DNS API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
uv run python umbrella_dns_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline umbrella_dns_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset umbrella_dns_data
The duckdb destination used duckdb:/umbrella_dns.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
uv run dlthub show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads /auth/v2/token and /reports/v2/activity from the Umbrella DNS API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def umbrella_dns_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.umbrella.com",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "deployments_networks", "endpoint": {"path": "deployments/v2/networks"}},
            {"name": "policies_destinations", "endpoint": {"path": "policies/v2/destinationlists/{id}/destinations"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="umbrella_dns_pipeline",
        destination="duckdb",
        dataset_name="umbrella_dns_data",
    )
    load_info = pipeline.run(umbrella_dns_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("umbrella_dns_pipeline").dataset()
sessions_df = data.deployments_networks.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM umbrella_dns_data.deployments_networks LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("umbrella_dns_pipeline").dataset()
data.deployments_networks.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Umbrella DNS data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI harness:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-platform — Deploy, schedule, and monitor your pipeline in production.

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack