Rapid7 AppSpider Python API Docs | dltHub

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

Last updated:

Rapid7 AppSpider Enterprise REST API is used to perform successful attacks on the REST API, collect information about the endpoint, good data, messages and parameters, and generate reports based on vulnerabilities found. The REST API base URL is http://{servername}/AppSpiderEnterprise/rest/v1/ and All API calls require an API Token obtained from a login endpoint, which is then submitted as a Basic 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 pip install "dlt[workspace]" and start loading Rapid7 AppSpider data in under 10 minutes.


What data can I load from Rapid7 AppSpider?

Here are some of the endpoints you can load from Rapid7 AppSpider:

ResourceEndpointMethodData selectorDescription
authentication_loginAuthentication/LoginPOSTTokenSA User Account Login
scan_engine_operationsScanEngineOperationsGETScan Engine Operations
scan_configuration_operationsScanConfigurationOperationsGETScan Configuration Operations
scan_managementScanManagementGETScan Management
report_managementReportManagementGETReport Management
findings_managementFindingsManagementGETFindings Management
client_operationsClientOperationsGETClient Operations
group_operationsGroupOperationsGETGroup Operations
role_operationsRoleOperationsGETRole Operations
account_operationsAccountOperationsGETAccount Operations
system_admin_operationsSystemAdminOperationsGETSystem Admin Operations
target_operationsTargetOperationsGETTarget Operations

How do I authenticate with the Rapid7 AppSpider API?

Authentication requires making a POST request to the login endpoint to obtain an API Token. This token is then used in subsequent requests as a Basic Authorization header, formatted as Authorization: Basic <Token>.

1. Get your credentials

  1. Make a POST request to the login endpoint: http://{servername}/AppSpiderEnterprise/rest/v1/Authentication/Login.
  2. The response will contain a Token field.
  3. Use this Token in the Authorization header of subsequent requests, formatted as Authorization: Basic <Token>.

2. Add them to .dlt/secrets.toml

[sources.rapid7_appspider_source] api_token = "your_api_token_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 Rapid7 AppSpider 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 rapid7_appspider_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline rapid7_appspider_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 authentication_login and scan_management from the Rapid7 AppSpider 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 rapid7_appspider_source(api_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "http://{servername}/AppSpiderEnterprise/rest/v1/", "auth": { "type": "http_basic", "password": api_token, }, }, "resources": [ {"name": "authentication_login", "endpoint": {"path": "Authentication/Login", "data_selector": "Token"}}, {"name": "scan_management", "endpoint": {"path": "ScanManagement"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="rapid7_appspider_pipeline", destination="duckdb", dataset_name="rapid7_appspider_data", ) load_info = pipeline.run(rapid7_appspider_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("rapid7_appspider_pipeline").dataset() sessions_df = data.scan_management.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM rapid7_appspider_data.scan_management LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("rapid7_appspider_pipeline").dataset() data.scan_management.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 Rapid7 AppSpider 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.


Troubleshooting

Authentication Errors

If you receive a 400 - Bad Request response with the reason InvalidCredentials and error message Invalid username or password., it indicates that the provided username or password for the login endpoint is incorrect.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.


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 Rapid7 AppSpider?

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