Load Codebeamer data to DuckDB

Codebeamer is an application lifecycle management platform that provides a REST API for accessing and managing system resources. Everything needed to build a working Codebeamer → 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 Codebeamer to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

PromptCopy prompt
Run uvx dlthub-init@latest to build a pipeline from Codebeamer 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 Codebeamer 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.

---

Codebeamer API at a glance

These values come from the Codebeamer API documentation. Check them against the vendor's current reference before relying on them in production.

---

How do I authenticate with the Codebeamer API?

All requests must include an Authorization header with Basic authentication (UTF-8 encoded credentials), an Accept header set to application/json, and an Accept-Language header.

1. Get your credentials

Codebeamer does not utilize user-facing API keys for general REST API access. Instead, it uses standard Basic Authentication, where your Codebeamer username and password serve as the credentials. To set up access: 1. Ensure your user account is assigned to a group that has the 'Rest / Remote API - Access' permission enabled in the Codebeamer system settings. 2. Use your standard login credentials (username/password) when configuring your API client. If using OpenID, follow your organization's OIDC provider workflow to obtain a Bearer token. Note that 'API Key' authentication methods listed in some internal documentation are reserved for component-to-component system communication and are not intended for end-user pipeline authentication.

2. Add them to .dlt/secrets.toml

Copy
[sources.codebeamer_source]
# Add these to your .dlt/secrets.toml file\n# Replace the placeholders with your actual Codebeamer credentials\ncodebeamer_username = \"your_username\"\ncodebeamer_password = \"your_password\"

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 Codebeamer data can I load into DuckDB?

These are the Codebeamer endpoints dlt can load into DuckDB:

---

How do I load only new Codebeamer records?

The Codebeamer API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

Copy
{"name": "projects", "endpoint": {
    "path": "v3/projects",
    # Replace with a field that increases on every write.
    "incremental": {"cursor_path": "REPLACE_ME", "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 Codebeamer pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading The most commonly used base URL paths for interacting with the API are cb/rest (for standard REST API resources) and v3/swagger/editor.spr (for accessing the Swagger UI/API documentation). from the Codebeamer API into DuckDB:

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

@dlt.source
def codebeamer_source(username=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://{hostname}/cb/rest",
            "auth": {"type": "http_basic", "username": "REPLACE_ME", "password": username},
        },
        "resources": [
            {"name": "projects", "endpoint": {"path": "v3/projects", "data_selector": "projects"}},
            {"name": "tracker_items", "endpoint": {"path": "v3/trackers/{trackerId}/items", "data_selector": "items"}}
        ],
    }
    yield from rest_api_resources(config)


def load_codebeamer_to_duckdb() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="codebeamer_pipeline",
        destination="duckdb",
        dataset_name="codebeamer_data",
    )
    load_info = pipeline.run(codebeamer_source())
    print(load_info)


if __name__ == "__main__":
    load_codebeamer_to_duckdb()

Run it with python codebeamer_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 Codebeamer 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):

Copy
import dlt

data = dlt.pipeline("codebeamer_pipeline").dataset()
df = data.projects.df()
print(df.head())

SQL:

Copy
SELECT * FROM codebeamer_data.projects LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.

---

How do I deploy the Codebeamer 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 Codebeamer loads into governed, documented models.
• Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →

---

What other destinations can I load Codebeamer data to?

dlt loads into any of these — only the destination argument changes:

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

• Ready for production? Book a demo of the dltHub platform →
• dlt LLM-native workflow docs
• REST API source reference
• Join the dlt community on Slack