SAP Table Message Server Python API Docs | dltHub
Build a SAP Table Message Server-to-database pipeline in Python using dlt with AI harness support for Claude Code, Cursor, and Codex.
Last updated:
The SAP Message Server provides a set of HTTP endpoints for monitoring internal SAP system information such as logon groups, application servers, and parameters. The REST API base URL is http://<mshost>:<ms_http_port>/msgserver/ and No standard REST authentication exists for the SAP Message Server; access is managed via network and internal port permissions..
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 SAP Table Message Server data in under 10 minutes.
What data can I load from SAP Table Message Server?
Here are some of the endpoints you can load from SAP Table Message Server:
| Resource | Endpoint | Method | Data selector | Description |
|---|---|---|---|---|
| application_servers | /msgserver/text/aslist | GET | Displays all application servers logged on to the message server. | |
| logon_groups | /msgserver/text/lglist | GET | Displays all logon groups for the system. | |
| parameters | /msgserver/text/parameter | GET | Displays message server parameters. | |
| group_info | /msgserver/text/group | GET | Displays detailed information on individual logon groups. | |
| commands | /msgserver/commands | GET | Displays available message server commands. |
How do I authenticate with the SAP Table Message Server API?
The SAP Message Server provides informational endpoints accessed via HTTP, but it does not function as a generic REST API with standardized token-based authentication. Access is typically controlled via system-level network configurations and internal port permissions rather than per-request authentication headers.
No credentials required. The SAP Table Message Server API is public, so there is nothing to obtain and nothing to add to .dlt/secrets.toml — the pipeline above runs as written.
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 harness:
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:
dlthub 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 SAP Table Message Server 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 sap_table_message_server_pipeline.py
If everything is configured correctly, you'll see output like this:
Pipeline sap_table_message_server_pipeline load step completed in 0.26 seconds 1 load package(s) were loaded to destination duckdb and into dataset sap_table_message_server_data The duckdb destination used duckdb:/sap_table_message_server.duckdb location to store data Load package 1749667187.541553 is LOADED and contains no failed jobs
Inspect your pipeline and data:
dlt pipeline sap_table_message_server_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 /msgserver/text/aslist and /msgserver/text/lglist (for monitoring); or custom endpoints like /read_table/{tablename} (if using a custom REST handler) from the SAP Table Message Server 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 sap_table_message_server_source(): config: RESTAPIConfig = { "client": { "base_url": "http://<mshost>:<ms_http_port>/msgserver/", }, "resources": [ {"name": "application_servers", "endpoint": {"path": "msgserver/text/aslist"}}, {"name": "logon_groups", "endpoint": {"path": "msgserver/text/lglist"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="sap_table_message_server_pipeline", destination="duckdb", dataset_name="sap_table_message_server_data", ) load_info = pipeline.run(sap_table_message_server_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("sap_table_message_server_pipeline").dataset() sessions_df = data.application_servers.df() print(sessions_df.head())
SQL (DuckDB example):
SELECT * FROM sap_table_message_server_data.application_servers LIMIT 10;
In a marimo or Jupyter notebook:
import dlt data = dlt.pipeline("sap_table_message_server_pipeline").dataset() data.application_servers.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 SAP Table Message Server 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.
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.
dlthub ai toolkit data-exploration install dlthub ai toolkit dlthub-platform install
Was this page helpful?
Community Hub
Need more dlt context for SAP Table Message Server?
Request dlt skills, commands, AGENT.md files, and AI-native context.