NETVPX Pterodactyl Python API Docs | dltHub

Pterodactyl Panel API provides endpoints for managing server resources, user administration, and administrative panel operations via Client and Application APIs. The REST API base URL is https://your-panel.com/api and all requests require a Bearer token in the Authorization 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 NETVPX Pterodactyl data in under 10 minutes.

---

What data can I load from NETVPX Pterodactyl?

Here are some of the endpoints you can load from NETVPX Pterodactyl:

---

How do I authenticate with the NETVPX Pterodactyl API?

Authentication is performed by sending an API key in the Authorization header using the Bearer token scheme (e.g., 'Authorization: Bearer '). Requests should also include 'Accept: Application/vnd.pterodactyl.v1+json' and 'Content-Type: application/json' headers.

1. Get your credentials

To obtain credentials for the Pterodactyl REST API, follow these steps based on the API type you intend to use: 1. Determine your API type: - Client API (for end-user server management): Use a Client API Key (prefix ptlc_). - Application API (for administrative panel management): Use an Application API Key (prefix ptla_). 2. Generate the key: - For Client API Keys: Log in to your Pterodactyl account, navigate to Account Settings (or https://your-panel.com/account/api), click "Create API Key," provide a description, and optionally restrict by IP addresses. - For Application API Keys (requires administrator access): Navigate to the Admin panel (or https://your-panel.com/admin/api), click "Create API Key," and configure the required resource permissions. 3. Important: Copy the generated API key immediately upon creation, as it will not be shown again. Each API key consists of a prefix (ptlc_ or ptla_), a 16-character identifier, and a 32-character token.

2. Add them to .dlt/secrets.toml

Copy
[sources.netvpx_pterodactyl_source]
api_key = "ptla_your_generated_application_api_key_here"
base_url = "https://your-panel.com/api/application"

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 NETVPX Pterodactyl 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 netvpx_pterodactyl_pipeline.py

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

Copy
Pipeline netvpx_pterodactyl_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset netvpx_pterodactyl_data
The duckdb destination used duckdb:/netvpx_pterodactyl.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/client and api/application from the NETVPX Pterodactyl 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 netvpx_pterodactyl_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://your-panel.com/api",
            "auth": {"type": "bearer", "token": api_key},
        },
        "resources": [
            {"name": "servers", "endpoint": {"path": "api/application/servers", "data_selector": "data"}},
            {"name": "nodes", "endpoint": {"path": "api/application/nodes", "data_selector": "data"}}
        ],
    }
    yield from rest_api_resources(config)


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

SQL (DuckDB example):

Copy
SELECT * FROM netvpx_pterodactyl_data.servers LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("netvpx_pterodactyl_pipeline").dataset()
data.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 NETVPX Pterodactyl 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