Load OPNsense data to DuckDB

OPNsense is an open source firewall platform that exposes a REST API for managing system modules and plugins. Everything needed to build a working OPNsense → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.

---

Build your OPNsense to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from OPNsense to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the OPNsense API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.

---

OPNsense API at a glance

These values come from the OPNsense API reference — the authoritative source if anything here looks out of date.

---

How do I authenticate with the OPNsense API?

Authentication is performed using HTTP Basic Authentication, where the API key is passed as the username and the API secret is passed as the password.

1. Get your credentials

1. Log in to the OPNsense web UI. 2. Navigate to System > Access > Users. 3. Select the user account for which you want to generate API credentials. 4. Scroll down to the API keys section. 5. Click the + (plus) button to create a new key pair. 6. A file containing your API Key and API Secret will be automatically downloaded to your computer. Store this file securely as the secret cannot be retrieved again later.

2. Add them to .dlt/secrets.toml

Copy
[sources.opnsense_source]
api_key = "REPLACE_ME"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.

---

What OPNsense data can I load into DuckDB?

These are the OPNsense endpoints dlt can load into DuckDB:

---

How do I load only new OPNsense records?

OPNsense exposes current on api/core/service/search, so dlt can request only the records that changed since the last run. Set it as the cursor_path and dlt tracks the high-water mark for you between runs.

Copy
{"name": "service_search", "endpoint": {
    "path": "api/core/service/search",
    "data_selector": "rows",
    "incremental": {"cursor_path": "current", "initial_value": "2024-01-01T00:00:00Z"},
}}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.

---

What does the generated OPNsense pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading /api/core/firmware/info and /api/diagnostics/interface/get from the OPNsense API into DuckDB:

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

@dlt.source
def opnsense_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<host>/api",
            "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": api_key},
        },
        "resources": [
            {"name": "service_search", "endpoint": {"path": "api/core/service/search", "data_selector": "rows"}},
            {"name": "rule_search", "endpoint": {"path": "api/firewall/filter/search_rule", "data_selector": "rows"}}
        ],
    }
    yield from rest_api_resources(config)


def load_opnsense_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="opnsense_pipeline",
        destination="duckdb",
        dataset_name="opnsense_data",
    )
    load_info = pipeline.run(opnsense_source())
    print(load_info)


if __name__ == "__main__":
    load_opnsense_to_duckdb()

Run it with python opnsense_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.

---

How do I query OPNsense data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("opnsense_pipeline").dataset()
df = data.service_search.df()
print(df.head())

SQL:

Copy
SELECT * FROM opnsense_data.service_search LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the OPNsense to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

• Deploy & schedule — run the pipeline as a managed job with automatic retries.
• Monitor — observable job queues, alerting, and load metrics for every run.
• Transform — promote raw OPNsense loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load OPNsense data to?

dlt loads into any of these — only the destination argument changes:

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.

---

Next steps

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack