Veeam Backup Python API Docs | dltHub

Veeam Backup & Replication provides a REST API for managing backup and recovery infrastructure programmatically. The REST API base URL is https://<hostname>:<port>/api/ and Logon uses Basic auth to obtain a session token, which is then passed in all subsequent requests via a custom 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 add "dlt[hub]" and start loading Veeam Backup data in under 10 minutes.

---

What data can I load from Veeam Backup?

Here are some of the endpoints you can load from Veeam Backup:

---

How do I authenticate with the Veeam Backup API?

The API uses Basic HTTP Authentication for initial logon by sending a base64-encoded username

pair in the Authorization header. Once a session is established, subsequent requests require the X-RestSvcSessionId header containing the session token returned by the server.

1. Get your credentials

Veeam APIs utilize two different authentication patterns depending on the deployment: 1) Veeam Backup Enterprise Manager REST API (port 9398) requires Basic Authentication. Send a POST request to /api/sessionMngr/ with your credentials in the Authorization header (Format: Basic <base64(username

)>). The server returns a session token in the X-RestSvcSessionId header. 2) Veeam Backup & Replication v13+ REST API (port 9419) uses OAuth 2.0. Send a POST request to /api/oauth2/token with the grant_type=password, username, and password in the body. Include the x-api-version header. The server returns an access token in the response body, which must be passed as Authorization: Bearer <access_token> in subsequent requests.

2. Add them to .dlt/secrets.toml

Copy
[sources.veeam_backup_source]
veeam_backup_token = "your_session_or_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:

Copy
uv init
uv add "dlt[hub]"

1. Install the dlt AI harness:

Copy
uv run dlthub 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:

Copy
uv run dlthub ai toolkit install rest-api-pipeline

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 Veeam Backup 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:

Copy
uv run python veeam_backup_pipeline.py

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

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

Inspect your pipeline and data:

Copy
uv run dlthub 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 /api/sessionMngr/ (Enterprise Manager) and /api/oauth2/token (B&R v13+ OAuth) from the Veeam Backup API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

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

@dlt.source
def veeam_backup_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<hostname>:<port>/api/",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "sessions", "endpoint": {"path": "api/v1/sessions"}},
            {"name": "backups", "endpoint": {"path": "api/backups"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="veeam_backup_pipeline",
        destination="duckdb",
        dataset_name="veeam_backup_data",
    )
    load_info = pipeline.run(veeam_backup_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):

Copy
import dlt

data = dlt.pipeline("veeam_backup_pipeline").dataset()
sessions_df = data.backups.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM veeam_backup_data.backups LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("veeam_backup_pipeline").dataset()
data.backups.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 Veeam Backup data to?

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

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

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

Copy
uv run dlthub ai toolkit install data-exploration
uv run dlthub ai toolkit install dlthub-platform

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack