FortiWeb Cloud Python API Docs | dltHub

Build a FortiWeb Cloud-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

FortiWeb Cloud RESTful API documentation is available at https://www.fortiweb-cloud.com/apidoc/api.html. It includes endpoints for managing global settings and cloud connectors. The API supports AWS, Azure, and GCP integrations. The REST API base URL is https://api.fortiweb-cloud.com/v2 and API key required in Authorization header (uses Basic scheme with the key secret).

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 pip install "dlt[workspace]" and start loading FortiWeb Cloud data in under 10 minutes.


What data can I load from FortiWeb Cloud?

Here are some of the endpoints you can load from FortiWeb Cloud:

ResourceEndpointMethodData selectorDescription
misc_knownbot_infomisc/knownbot-infoGETresult.bot-listGet known bad bot list by category
backend_ip_testmisc/backend-ip-testGETCheck backend network connectivity (returns object fields like network_connectivity)
applicationsapplicationGETresultsList applications (response contains a top‑level "results" array)
application_ml_api_protectionapplication/{ep_id}/ml_api_protectionGETresultGet ML based API protection config for an application
application_mobile_api_protectionapplication/{ep_id}/mobile_api_protectionGETresult.configs.url_listGet mobile API protection config (url_list contains array of URLs)

How do I authenticate with the FortiWeb Cloud API?

FortiWeb Cloud requires an API key provided in the HTTP Authorization header. Include header: Authorization: Basic . Requests should also set Accept: application/json.

1. Get your credentials

  1. Log into your FortiWeb Cloud account. 2) Open Settings / API Key (see FortiWeb Cloud User Guide or API docs). 3) Generate a new API key/secret and copy the secret value. 4) Use the secret as the value in the Authorization header as described above.

2. Add them to .dlt/secrets.toml

[sources.fortiweb_cloud_source] api_key = "your_fortiweb_cloud_api_key_here"

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:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

dlt 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:

dlt ai toolkit rest-api-pipeline install

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 FortiWeb Cloud 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:

python fortiweb_cloud_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline fortiweb_cloud_pipeline 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 applications and misc_knownbot_info from the FortiWeb Cloud API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def fortiweb_cloud_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://api.fortiweb-cloud.com/v2", "auth": { "type": "api_key", "api_key": api_key, }, }, "resources": [ {"name": "misc_knownbot_info", "endpoint": {"path": "misc/knownbot-info", "data_selector": "result.bot-list"}}, {"name": "applications", "endpoint": {"path": "application", "data_selector": "results"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="fortiweb_cloud_pipeline", destination="duckdb", dataset_name="fortiweb_cloud_data", ) load_info = pipeline.run(fortiweb_cloud_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):

import dlt data = dlt.pipeline("fortiweb_cloud_pipeline").dataset() sessions_df = data.knownbot_info.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM fortiweb_cloud_data.knownbot_info LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("fortiweb_cloud_pipeline").dataset() data.knownbot_info.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 FortiWeb Cloud data to?

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

DestinationExample value
DuckDB (local, default)"duckdb"
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

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 Workbench:

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

Was this page helpful?

Community Hub

Need more dlt context for FortiWeb Cloud?

Request dlt skills, commands, AGENT.md files, and AI-native context.