Apigee Python API Docs | dltHub

Build a Apigee-to-database pipeline in Python using dlt with AI Workbench support for Claude Code, Cursor, and Codex.

Last updated:

Apigee limits include a 15 MB size for API proxy files, 2 KB for API keys, and 18 custom attributes per entity. Cache keys are 2 KB, and cache values are 256 KB. The REST API base URL is Apigee Edge (classic): https://api.enterprise.apigee.com/v1 Apigee X / Cloud: https://apigee.googleapis.com/v1 and All management API requests require OAuth 2.0 / Google Cloud authentication (Bearer token) or Edge Basic auth for some Edge-level token endpoints..

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 Apigee data in under 10 minutes.


What data can I load from Apigee?

Here are some of the endpoints you can load from Apigee:

ResourceEndpointMethodData selectorDescription
organizationsorganizationsGETList organizations available to caller
apisorganizations/{org}/apisGETList API proxies in an organization (returns top-level array of proxy names)
developersorganizations/{org}/developersGETList developers in an organization (top-level array)
developer_appsorganizations/{org}/developers/{developer_email}/appsGETList apps for a developer (top-level array)
environmentsorganizations/{org}/environmentsGETList environments in an organization (top-level array)
deploymentsorganizations/{org}/environments/{env}/apis/{api}/deploymentsGETdeploymentsDeployment details for an API proxy (response contains 'deployments' array)
revisionsorganizations/{org}/apis/{api}/revisionsGETList revision numbers for an API proxy (top-level array)
keystoresorganizations/{org}/environments/{env}/keystoresGETList keystores (top-level array)
cachesorganizations/{org}/environments/{env}/cachesGETList caches in environment (top-level array)
oauth_tokensorganizations/{org}/oauth2/accesstokens/{access_token}GETRetrieve OAuth access token details

How do I authenticate with the Apigee API?

Apigee management APIs use Google Cloud OAuth2 for Apigee X (use a service account or gcloud-auth obtained token in the Authorization: Bearer header). Apigee Edge management operations historically accept Basic auth or an Apigee management token obtained from the Edge OAuth/token endpoints; token requests use client_id and client_secret submitted as HTTP Basic or form parameters.

1. Get your credentials

  1. For Apigee X (recommended): create or use a Google Cloud service account with Apigee permissions, download JSON key, then run gcloud auth activate-service-account --key-file=KEY.json and obtain an access token via gcloud auth print-access-token or use application default credentials in code. 2) For Apigee Edge (on-prem/classic): register a developer app to get client_id/client_secret, then request a management access token via the OAuth token endpoint using grant_type=client_credentials with Basic auth (base64 client_id:client_secret) or form parameters.

2. Add them to .dlt/secrets.toml

[sources.apigee_source] management_token = "your_bearer_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:

uv venv && source .venv/bin/activate uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

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

dlt 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 Apigee 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 apigee_pipeline.py

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

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

Inspect your pipeline and data:

dlt pipeline apigee_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 apis and deployments from the Apigee 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 apigee_source(management_token=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "Apigee Edge (classic): https://api.enterprise.apigee.com/v1 Apigee X / Cloud: https://apigee.googleapis.com/v1", "auth": { "type": "bearer", "token": management_token, }, }, "resources": [ {"name": "apis", "endpoint": {"path": "organizations/{org}/apis"}}, {"name": "deployments", "endpoint": {"path": "organizations/{org}/environments/{env}/apis/{api}/deployments", "data_selector": "deployments"}} ], } yield from rest_api_resources(config) def get_data() -> None: pipeline = dlt.pipeline( pipeline_name="apigee_pipeline", destination="duckdb", dataset_name="apigee_data", ) load_info = pipeline.run(apigee_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("apigee_pipeline").dataset() sessions_df = data.apis.df() print(sessions_df.head())

SQL (DuckDB example):

SELECT * FROM apigee_data.apis LIMIT 10;

In a marimo or Jupyter notebook:

import dlt data = dlt.pipeline("apigee_pipeline").dataset() data.apis.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 Apigee data to?

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

DestinationExample 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 Workbench:

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

Was this page helpful?

Community Hub

Need more dlt context for Apigee?

Request dlt skills, commands, AGENT.md files, and AI-native context.