NexoVirt REST API reference

This interactive REST API reference documents every endpoint of the NexoVirt Proxmox VE control panel under /api/v1: hosts, nodes, the full guest lifecycle, users, IP addresses, plans and jobs. Authenticate with a bearer token from Settings, API tokens, and every response uses the same{success, data, error} envelope. Try any call from the panel below.

Authentication and limits

Every request sends Authorization: Bearer <token>. A token can be limited to selected hosts and to an IP allowlist, and each token is rate limited. A call to a host the token is not scoped to returns 403, so a script can never reach a host it was not meant for.

Lists and long-running jobs

List endpoints are paginated and return the totals in meta. Creating, reinstalling, deleting and powering a guest are queued: the call returns a job at once, and you pollGET /api/v1/hosts/{id}/jobs/{jobId} until it is done. Discovery endpoints for plans, OS templates, container templates, IP zones and the next free VMID return every identifier a create call needs, and none of them ever returns a secret.

Related reading