proxmox_api

Contents

  • Quick Start
  • API Reference
proxmox_api
  • proxmox_api
  • View page source

proxmox_api

A Python wrapper around the Proxmox VE REST API.

proxmox_api provides a typed, Pythonic interface to manage QEMU VMs, LXC containers, storage, cluster resources, and more through the Proxmox API.

Contents

  • Quick Start
    • Installation
    • Connecting
    • Basic usage
    • Listing VMs and containers
    • VM lifecycle
  • API Reference
    • client – ProxmoxAPI
    • _base – Resource base class
    • access – Access / authentication
    • cluster – Cluster resources
    • nodes – Node resources
    • qemu – QEMU VM resources
    • lxc – LXC container resources
    • node_resources – Disks & node firewall
    • storage – Storage resources
    • pools – Pool resources
    • parse_apidoc – API doc parser

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2025, proxmox_api contributors.

Built with Sphinx using a theme provided by Read the Docs.