IBM z/OS Python API Docs | dltHub

IBM z/OS Connect and associated z/OS REST services provide APIs for interacting with mainframe applications and resources. The REST API base URL is https://<host>:<port> and supports HTTP Basic Authentication and JWT bearer token authentication.

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 IBM z/OS data in under 10 minutes.

---

What data can I load from IBM z/OS?

Here are some of the endpoints you can load from IBM z/OS:

---

How do I authenticate with the IBM z/OS API?

Authentication is typically handled via HTTP Basic Authentication (sending base64-encoded user ID and password in the Authorization header) or by sending a JSON Web Token (JWT) in the Authorization header, often using the Bearer scheme.

1. Get your credentials

To authenticate with the IBM z/OSMF REST API, you typically use a z/OS user ID and password. 1. Access the z/OSMF server via your browser or a client program. 2. Perform a POST request to the /zosmf/services/authenticate endpoint with your credentials in the Authorization: Basic header (Base64 encoded userid

). 3. Include the required X-CSRF-ZOSMF-HEADER header in your request. 4. Upon successful authentication, the server returns an LTPA token (e.g., LtpaToken2) or a JSON Web Token (JWT), which should be stored as a cookie or header for subsequent API calls. Alternatively, consult your z/OS administrator to enable Identity Propagation, which allows API invocation without explicit credentials if the client is already authenticated within the sysplex.

2. Add them to .dlt/secrets.toml

Copy
[sources.ibm_z_os_source]
zosmf_user = "your_username"
zosmf_password = "your_password"
# Or if using a pre-generated token:
# zosmf_token = "your_jwt_or_ltpa_token"

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 IBM z/OS 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 ibm_z_os_pipeline.py

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

Copy
Pipeline ibm_z_os_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset ibm_z_os_data
The duckdb destination used duckdb:/ibm_z_os.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 /zosmf/services/authenticate and /zosmf/restjobs/jobs from the IBM z/OS 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 ibm_z_os_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://<host>:<port>",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "unix_filesystems", "endpoint": {"path": "zosmf/restfiles/mfs/"}},
            {"name": "volumes", "endpoint": {"path": "zosmf/storage/rest/v1/volumes"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="ibm_z_os_pipeline",
        destination="duckdb",
        dataset_name="ibm_z_os_data",
    )
    load_info = pipeline.run(ibm_z_os_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("ibm_z_os_pipeline").dataset()
sessions_df = data.volumes.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM ibm_z_os_data.volumes LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("ibm_z_os_pipeline").dataset()
data.volumes.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 IBM z/OS 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