proxmoxer

What it is and what it does

Proxmoxer is a Python client library that wraps the Proxmox REST API, allowing you to manage virtual machines, containers, and infrastructure resources programmatically. It supports three connection backends—HTTPS, SSH via Paramiko, and OpenSSH—so you can choose the transport that fits your environment. The library dynamically constructs API calls from attribute access patterns, mapping them directly to Proxmox API endpoints, so you write code like `proxmox.nodes.get()` or `proxmox.nodes(node_name).qemu.get()` rather than manually building HTTP requests.

The package has been in active development since 2013 and recently released version 2.3.0, which introduced breaking changes but improved the API design. It targets system administrators and developers who need to automate Proxmox deployments, provision infrastructure, or integrate Proxmox management into larger Python applications. With no runtime dependencies in the base install and optional backends you pull in only when needed, it's lightweight and flexible for different deployment scenarios.

Use it for:

• Automate VM and container provisioning across a Proxmox cluster from a Python script or application.
• Monitor node status and resource usage by querying Proxmox API endpoints programmatically.
• Integrate Proxmox management into infrastructure-as-code tools or CI/CD pipelines.
• Build custom dashboards or reporting tools that pull live data from PVE, PMG, or PBS.
• Manage Proxmox Backup Server backups and retention policies via Python automation.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Proxmoxer is a Python wrapper for the Proxmox REST API that lets you programmatically manage Proxmox Virtual Environment (PVE), Proxmox Mail Gateway (PMG), and Proxmox Backup Server (PBS) over HTTPS, SSH, or the pvesh utility.

Yes. Proxmoxer is production-stable (Development Status 5), actively maintained, has no security vulnerabilities, and carries a permissive MIT license. Install friction is minimal. It's the standard Python client for Proxmox automation and is well-suited for anyone managing Proxmox infrastructure programmatically. Only caveat: ensure you install the backend library that matches your connection method.

Install

proxmoxer on PyPI

pip install proxmoxer

uv add proxmoxer

poetry add proxmoxer

Installing proxmoxer

Before you install

Low install friction; pure Python wheel with no compiled dependencies. Actively maintained with a recent release 163 days ago. Optional backends are installed separately as needed.

License in practice

MIT license (permissive); you can use this freely in commercial and private projects with minimal restrictions.

Quickstart

pip install proxmoxer

from proxmoxer import ProxmoxAPI

proxmox = ProxmoxAPI('proxmox_host', user='admin@pam', password='secret', verify_ssl=False)
for node in proxmox.nodes.get():
    print(node)

Optional backend libraries (for HTTPS, SSH, or openssh connections) must be installed separately depending on your connection method.

Verify before relying

• Exact Python version support (requires_python field is unspecified in metadata)
• Whether all three backends (https, ssh_paramiko, openssh) are equally stable and feature-complete
• Performance characteristics and scalability limits for large Proxmox clusters

Package facts

Evidence: proxmoxer-2.3.0-py3-none-any.whl

Keywords: proxmox, api

Tags

More Python Modules packages