Proxmox VE

Proxmox VE API

REST-style management API for Proxmox VE covering nodes, virtual machines, containers, storage, networking, clustering, pools, and access management. Authenticated via API tokens (PVEAPIToken header) or ticket-based sessions with CSRFPreventionToken for write operations.

GitHub

Documentation

📖
Documentation
https://pve.proxmox.com/wiki/Proxmox_VE_API
📖
Authentication
https://pve.proxmox.com/wiki/Proxmox_VE_API#Authentication

Other Resources

🔗
API Viewer
https://pve.proxmox.com/pve-docs/api-viewer/

API entry from apis.yml

apis.yml Raw ↑ 
aid: proxmox:ve-api
name: Proxmox VE API
description: REST-style management API for Proxmox VE covering nodes, virtual machines, containers, storage,
  networking, clustering, pools, and access management. Authenticated via API tokens (PVEAPIToken header)
  or ticket-based sessions with CSRFPreventionToken for write operations.
humanURL: https://pve.proxmox.com/wiki/Proxmox_VE_API
baseURL: https://your.server:8006/api2/json
tags:
- Virtualization
- Cluster Management
- Infrastructure
properties:
- type: Documentation
  url: https://pve.proxmox.com/wiki/Proxmox_VE_API
- type: API Viewer
  url: https://pve.proxmox.com/pve-docs/api-viewer/
- type: Authentication
  url: https://pve.proxmox.com/wiki/Proxmox_VE_API#Authentication