Get

proxmox get --help

Input:

proxmox get --help

Output:

 Usage: proxmox get [OPTIONS] PATH                                              

 Retrieve resources from the Proxmox API.                                       

 Fetches data from API endpoints with optional filtering, pagination,           
 watching/monitoring, and flexible output formatting.                           

 Examples:                                                                      
     # List all nodes                                                           
     proxmox get /nodes                                                         

     # Get specific node info                                                   
     proxmox get /nodes/pve1/status                                             

     # Get VMs on a node                                                        
     proxmox get /nodes/pve1/qemu --output json                                 

     # Filter results                                                           
     proxmox get /nodes/pve1/qemu --filter status=running --limit 10            

     # Watch resource for changes (refresh every 5 seconds)                     
     proxmox get /nodes/pve1/status --watch 5                                   

     # Get storage list with YAML output                                        
     proxmox get /storage --yaml                                                

     # Select specific columns                                                  
     proxmox get /nodes/pve1/qemu --columns vmid,name,status --output table     

╭─ Arguments ──────────────────────────────────────────────────────────────────╮
│ *    path      TEXT  API path to retrieve [required]                         │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --columns   -c      TEXT     Comma-separated columns to display              │
│ --limit     -l      INTEGER  Maximum number of results to return             │
│ --offset            INTEGER  Number of results to skip (for pagination)      │
│ --filter    -f      TEXT     Filter results (field=value or field~substring) │
│ --watch     -w      INTEGER  Refresh every N seconds (Ctrl+C to stop)        │
│ --output    -o      TEXT     Output format (human, json, yaml, markdown,     │
│                              table, text, raw)                               │
│ --json                       Shortcut for --output json                      │
│ --yaml                       Shortcut for --output yaml                      │
│ --markdown                   Shortcut for --output markdown                  │
│ --help                       Show this message and exit.                     │
╰──────────────────────────────────────────────────────────────────────────────╯

Exit code: 0 · Wall time (s): 0.235

---