NexoVirt SDK for Python

Official Python client for the NexoVirt REST API, a clean, token-authenticated API over Proxmox VE for managing hosts, guests (KVM VMs + LXC containers), plans, IPAM, firewall, snapshots and more.

• Docs: NexoVirt REST API reference
• What is NexoVirt: a self-hosted control panel and REST API for Proxmox VE. See nexovirt.com

Generated from the NexoVirt OpenAPI specification, so it always matches the live API. See Regenerating below.

Install

pip install nexovirt

Quick start

Create an API token in your panel under Settings → API tokens, then point the client at your panel's /api/v1 base URL:

import nexovirt
from nexovirt.api.hosts_nodes_api import HostsNodesApi
from nexovirt.api.guests_api import GuestsApi

config = nexovirt.Configuration(
    host="https://your-panel.example/api/v1",
    access_token="YOUR_TOKEN",  # Bearer token from Settings -> API tokens
)

with nexovirt.ApiClient(config) as client:
    hosts = HostsNodesApi(client)
    guests = GuestsApi(client)

    all_hosts = hosts.list_hosts()          # every Proxmox host
    result = guests.list_guests(host_id=1)  # guests on host 1
    print(result.data)

Every response uses the NexoVirt envelope { success, data, error }; list endpoints add meta: { page, perPage, total }.

Authentication

All requests send Authorization: Bearer <token>. Tokens can be host-scoped, IP-allowlisted and rate-limited in the panel. A scoped token gets 403 on any host it may not touch.

Regenerating

This SDK is generated with OpenAPI Generator:

./scripts/regenerate.sh

License

MIT. See LICENSE.