Load OWASP ZAP data to DuckDB
Build a OWASP ZAP to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the OWASP ZAP API base URL, auth, endpoints, and incremental loading.
OWASP ZAP (Zed Attack Proxy) is an open-source web application security scanner that provides a REST API for controlling and accessing its features. Everything needed to build a working OWASP ZAP → 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 OWASP ZAP to DuckDB pipeline
Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.
PromptRunuvx dlthub-init@latestto build a pipeline from OWASP ZAP 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 OWASP ZAP 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.
OWASP ZAP API at a glance
| Base URL | http://127.0.0.1:8080/ |
| Example endpoint | GET JSON/alert/view/alerts/ |
| Records found at | alerts |
| Authentication | requests require an API key passed as a header or query parameter — sent in the X-ZAP-API-Key header |
| Pagination | Offset-based via start, page size via count (default 5000). Pagination is implemented via the 'start' (position) and 'count' (page size) parameters across multiple view endpoints. There is no next page token; clients must manually increment the 'start' parameter by the number of results retrieved. |
| Incremental field | start |
| Record id | id |
| API reference | https://www.zaproxy.org/docs/api/ |
These values come from the OWASP ZAP API reference — the authoritative source if anything here looks out of date.
How do I authenticate with the OWASP ZAP API?
The API key can be provided either as a header named 'X-ZAP-API-Key' or as a query parameter named 'apikey'. It is required for all 'actions' and some 'other' operations.
1. Get your credentials
To obtain your API key in the ZAP Desktop interface, navigate to Tools -> Options -> API. The API key is displayed there. If you are running ZAP in daemon (headless) mode, you can set the key at startup using the command line flag -config api.key=YOUR_KEY_HERE.
2. Add them to .dlt/secrets.toml
[sources.owasp_zap_source] zap_api_key = "your_api_key_here" zap_base_url = "http://localhost:8080"
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 OWASP ZAP data can I load into DuckDB?
These are the OWASP ZAP endpoints dlt can load into DuckDB:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| alerts | /JSON/alert/view/alerts/ | GET | alerts | Gets the alerts raised by ZAP, with optional filtering and pagination. |
| messages | /JSON/core/view/messages/ | GET | messages | Gets the HTTP messages sent by ZAP, with optional filtering and pagination. |
| hosts | /JSON/core/view/hosts/ | GET | hosts | Gets the name of hosts accessed through/by ZAP. |
| spider_results | /JSON/spider/view/results/ | GET | results | Lists all the resources crawled by the Spider. |
| alerts_summary | /JSON/alert/view/alertsSummary/ | GET | alertsSummary | Gets a summary of the alerts categorized by risk level. |
How do I load only new OWASP ZAP records?
OWASP ZAP exposes start on JSON/alert/view/alerts/, 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.
{"name": "alerts", "endpoint": { "path": "JSON/alert/view/alerts/", "data_selector": "alerts", "incremental": {"cursor_path": "start", "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 OWASP ZAP pipeline look like?
A standard dlt REST API pipeline — the same code you would write by hand, loading core/action/shutdown and core/view/hosts from the OWASP ZAP API into DuckDB:
import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def owasp_zap_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "http://127.0.0.1:8080/", "auth": {"type": "api_key", "api_key": api_key, "name": "X-ZAP-API-Key", "location": "header"}, }, "resources": [ {"name": "alerts", "endpoint": {"path": "JSON/alert/view/alerts/", "data_selector": "alerts"}}, {"name": "messages", "endpoint": {"path": "JSON/core/view/messages/", "data_selector": "messages"}} ], } yield from rest_api_resources(config) def load_owasp_zap_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="owasp_zap_pipeline", destination="duckdb", dataset_name="owasp_zap_data", ) load_info = pipeline.run(owasp_zap_source()) print(load_info) if __name__ == "__main__": load_owasp_zap_to_duckdb()
Run it with python owasp_zap_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 OWASP ZAP 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):
import dlt data = dlt.pipeline("owasp_zap_pipeline").dataset() df = data.alerts.df() print(df.head())
SQL:
SELECT * FROM owasp_zap_data.alerts LIMIT 10;
See querying your data with dataset and exploring it in marimo notebooks.
How do I deploy the OWASP ZAP 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 OWASP ZAP loads into governed, documented models.
- Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.
What other destinations can I load OWASP ZAP data to?
dlt loads into any of these — only the destination argument changes:
| Destination | Example value |
|---|---|
| PostgreSQL | "postgres" |
| BigQuery | "bigquery" |
| Snowflake | "snowflake" |
| Redshift | "redshift" |
| Databricks | "databricks" |
| Filesystem (S3, GCS, Azure) | "filesystem" |
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
Was this page helpful?
Community Hub
Need more dlt context for OWASP ZAP to DuckDB?
Request dlt skills, commands, AGENT.md files, and AI-native context.