pvesh
Command-line Proxmox REST API access
TLDR
List available nodes
$ pvesh get /nodes
Display detailed information about containers or VMs$ pvesh get /nodes/[node_name]/[lxc|qemu]
Discover API paths$ pvesh ls /
Display API path usage instructions$ pvesh usage /pools
Add a new thinpool storage$ pvesh create /storage --storage [storage_id] --vgname [volume_group] --type lvmthin --thinpool [thinpool_name] --content [content_types]
SYNOPSIS
pvesh command path [options]
DESCRIPTION
pvesh provides direct command-line access to the Proxmox VE REST API. It allows querying and modifying all cluster resources including nodes, VMs, containers, storage, and users. This is useful for scripting and automation tasks.The tool mirrors the web interface's capabilities, enabling administrators to perform any operation available through the GUI from the command line or scripts.
PARAMETERS
get, g
Retrieve data from API pathls, l
List available subpathsusage, u
Show usage information for API pathcreate
Create new resource at API pathset
Modify existing resourcedelete
Remove resource at API path--output-format format
Output format (text, json, json-pretty)
CAVEATS
Requires root privileges or appropriate Proxmox permissions. API paths match the web interface structure. Complex operations may require multiple API calls.
HISTORY
Part of Proxmox VE, providing CLI access to the same API used by the web interface. Essential for automation, scripting, and headless administration of Proxmox clusters.
