Broadcom VMware Live Cyber Recovery Python API Docs | dltHub
Build a Broadcom VMware Live Cyber Recovery-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.
Last updated:
VMware Live Cyber Recovery API is a REST interface that provides programmatic access to the service's major components for cyber recovery operations. The REST API base URL is https://{instance}.app.vcdr.vmware.com/api/vcdr/v1 and All requests require a Bearer access token passed in the x-da-access-token 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 Broadcom VMware Live Cyber Recovery data in under 10 minutes.
What data can I load from Broadcom VMware Live Cyber Recovery?
Here are some of the endpoints you can load from Broadcom VMware Live Cyber Recovery:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| cloud_file_systems | /cloud-file-systems | GET | cloudFileSystems | List Cloud File Systems |
| protected_sites | /protected-sites | GET | protectedSites | List Protected Sites |
| protected_vms | /protected-vms | GET | protectedVms | List Protected Virtual Machines |
| protection_groups | /protection-groups | GET | protectionGroups | List Protection Groups |
| protection_group_snapshots | /protection-groups/{id}/snapshots | GET | snapshots | List Snapshots for a Protection Group |
| recovery_plans | /recovery-plans | GET | recoveryPlans | List Recovery Plans |
| recovery_sddcs | /recovery-sddcs | GET | recoverySddcs | List Recovery SDDCs |
How do I authenticate with the Broadcom VMware Live Cyber Recovery API?
Obtain a CSP API token from the VMware Cloud Services console, exchange it for an access token via the token‑exchange endpoint, and include the access token in the "x-da-access-token" request header.
1. Get your credentials
- Log in to https://console.cloud.vmware.com.
- Navigate to "My User Settings" → "API Tokens".
- Click "Create Token", give it a name, and copy the generated token.
- Use this token in the token‑exchange request to obtain an access token for the Live Cyber Recovery API.
2. Add them to .dlt/secrets.toml
[sources.broadcom_vmware_live_cyber_recovery_source] access_token = "your_access_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 Broadcom VMware Live Cyber Recovery 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 broadcom_vmware_live_cyber_recovery_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline broadcom_vmware_live_cyber_recovery_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset broadcom_vmware_live_cyber_recovery_data The duckdb destination used duckdb:/broadcom_vmware_live_cyber_recovery.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline broadcom_vmware_live_cyber_recovery_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 cloud_file_systems and protected_sites from the Broadcom VMware Live Cyber Recovery 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 broadcom_vmware_live_cyber_recovery_source(access_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://{instance}.app.vcdr.vmware.com/api/vcdr/v1", "auth": { "type": "bearer", "token": access_token, }, }, "resources": [ {"name": "cloud_file_systems", "endpoint": {"path": "cloud-file-systems", "data_selector": "cloudFileSystems"}}, {"name": "protected_sites", "endpoint": {"path": "protected-sites", "data_selector": "protectedSites"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="broadcom_vmware_live_cyber_recovery_pipeline", destination="duckdb", dataset_name="broadcom_vmware_live_cyber_recovery_data", ) load_info = pipeline.run(broadcom_vmware_live_cyber_recovery_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("broadcom_vmware_live_cyber_recovery_pipeline").dataset() sessions_df = data.cloud_file_systems.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM broadcom_vmware_live_cyber_recovery_data.cloud_file_systems LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("broadcom_vmware_live_cyber_recovery_pipeline").dataset() data.cloud_file_systems.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 Broadcom VMware Live Cyber Recovery data to?
dlt supports loading into any of these destinations — only the destination parameter changes:
| Destination | Example 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
- 401 Unauthorized – Occurs when the
x-da-access-tokenheader is missing, malformed, or the token has expired. Obtain a fresh access token via the CSP token‑exchange endpoint.
Rate Limiting
- 429 Too Many Requests – The API enforces request quotas. Respect the
Retry-Afterheader and implement exponential back‑off before retrying.
Pagination
- Many list endpoints return paginated results using
pageandpage_sizequery parameters. Continue fetching pages until the response indicates no furthernext_pagetoken.
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 Broadcom VMware Live Cyber Recovery?
Request dlt skills, commands, AGENT.md files, and AI-native context.