emersonfelipesp/proxmox-openapi repository overview

⁠proxmox-openapi

proxmox-openapi is a schema-driven FastAPI service for the Proxmox VE API.

It provides an OpenAPI-based interface on top of Proxmox, making it easier to explore, test, validate, and integrate Proxmox endpoints from automation tools, client generators, and internal platforms.

This image supports two modes:

• Mock mode (default): runs a fully documented mock Proxmox API with generated data and in-memory CRUD operations, which is useful for development, testing, demos, and CI pipelines.
• Real mode: connects to a real Proxmox VE server and proxies requests through a validated API layer.

⁠What it does

• Exposes a FastAPI application for Proxmox API workflows
• Serves interactive OpenAPI/Swagger documentation at /docs
• Lets you develop and test against a mock Proxmox API without needing a live cluster
• Lets you switch to real Proxmox integration by setting the required environment variables
• Helps standardize Proxmox API consumption for tooling, SDK generation, and internal automation

⁠Quick start

Run in mock mode:

docker run --rm -p 8000:8000 emersonfelipesp/proxmox-openapi:latest