Skip to content

API‐and‐Privileges

realstuffie edited this page Oct 28, 2026 · 2 revisions

API & Privileges

Token setup

ProxMon uses Proxmox API tokens for authentication. Format: user@realm!tokenname

Example: root@pam!plasma-monitor

Privilege separation

If a token is created with privilege separation enabled (--privsep 1, the default), it does not automatically inherit the user's ACLs. Effective permissions are the intersection of user and token permissions.

# Create token with separated privileges
pveum user token add joe@pve monitoring --privsep 1

# Grant read-only role to token
pveum acl modify /vms --tokens 'joe@pve!monitoring' --roles PVEAuditor

ProxMon also reads node status at /, so a separated token needs Sys.Audit there as well. The full permission list, including storage, consoles, the guest agent and Proxmox Backup Server, is on the Proxmox Setup page.

Recommended pattern

  • Monitoring token: Sys.Audit + VM.Audit (read-only)
  • Actions token: VM.PowerMgmt at minimum scope needed, with "Enable power actions" ticked in the Behavior tab

Proxmox built-in roles: PVEAuditor (read-only), PVEVMUser (includes VM.PowerMgmt).

Clone this wiki locally