Proxmox VE

API Endpoints Complete Reference

2 min read

API Endpoints Complete Reference

Overview

Complete reference for all Proxmox VE REST API v2 endpoints with parameters and responses.

Base URL

https://<host>:8006/api2/json/

Cluster Endpoints

Cluster Status

GET /cluster/status

Response:

{
  "data": [
    {
      "type": "node",
      "node": "pve1",
      "status": "online",
      "uptime": 86400,
      "cpu": 0.05,
      "mem": 8589934592,
      "maxmem": 17179869184,
      "disk": 107374182400,
      "maxdisk": 214748364800
    }
  ]
}

Cluster Resources

GET /cluster/resources

Parameters:

  • type: node, vm, storage

Cluster HA Status

GET /cluster/ha/status

Cluster Backup

GET /cluster/backup
POST /cluster/backup

Node Endpoints

Node Status

GET /nodes/{node}/status

Node subscriptions

GET /nodes/{node}/subscription

Node Scan

GET /nodes/{node}/scan

Node DNS

GET /nodes/{node}/dns
PUT /nodes/{node}/dns

Node APT

GET /nodes/{node}/apt/update
GET /nodes/{node}/apt/changelog
POST /nodes/{node}/apt/update

Node Disk

GET /nodes/{node}/disk
POST /nodes/{node}/disk

VM Endpoints (QEMU)

List VMs

GET /nodes/{node}/qemu

Create VM

POST /nodes/{node}/qemu

Parameters:

  • vmid: VM ID
  • name: VM name
  • memory: Memory in MB
  • cores: Number of cores
  • cpu: CPU type
  • ostype: OS type
  • scsi0: Storage:size
  • net0: Network config

VM Status

GET /nodes/{node}/qemu/{vmid}/status
POST /nodes/{node}/qemu/{vmid}/status/start
POST /nodes/{node}/qemu/{vmid}/status/stop
POST /nodes/{node}/qemu/{vmid}/status/shutdown
POST /nodes/{node}/qemu/{vmid}/status/reset
POST /nodes/{node}/qemu/{vmid}/status/suspend

VM Config

GET /nodes/{node}/qemu/{vmid}/config
PUT /nodes/{node}/qemu/{vmid}/config

VM Monitor

GET /nodes/{node}/qemu/{vmid}/monitor
POST /nodes/{node}/qemu/{vmid}/monitor

VM VNC WebSocket

GET /nodes/{node}/qemu/{vmid}/vncwebsocket

VM Clone

POST /nodes/{node}/qemu/{vmid}/clone

Parameters:

  • newid: Target VM ID
  • name: New name
  • full: Full clone (1/0)

VM Template

POST /nodes/{node}/qemu/{vmid}/template

VM Migrate

POST /nodes/{node}/qemu/{vmid}/migrate

Parameters:

  • target: Target node
  • online: 1 for live migration
  • storage: Target storage

Container Endpoints (LXC)

List Containers

GET /nodes/{node}/lxc

Create Container

POST /nodes/{node}/lxc

Parameters:

  • vmid: Container ID
  • ostype: debian, ubuntu, centos, alpine
  • hostname: Hostname
  • rootfs: Storage:size
  • memory: Memory in MB
  • cores: CPU cores
  • net0: Network config

Container Status

GET /nodes/{node}/lxc/{vmid}/status
POST /nodes/{node}/lxc/{vmid}/status/start
POST /nodes/{node}/lxc/{vmid}/status/stop
POST /nodes/{node}/lxc/{vmid}/status/restart

Container Config

GET /nodes/{node}/lxc/{vmid}/config
PUT /nodes/{node}/lxc/{vmid}/config

Storage Endpoints

List Storage

GET /storage
POST /storage
DELETE /storage/{storage-id}

Storage Content

GET /storage/{storage-id}/content

Storage Status

GET /storage/{storage-id}/status

Storage-Remove

POST /storage/{storage-id}/prune

Access/User Endpoints

List Users

GET /access/users
POST /access/users
DELETE /access/users/{userid}

User Config

GET /access/users/{userid}
PUT /access/users/{userid}

List Groups

GET /access/groups
POST /access/groups

List ACLs

GET /access/acl
POST /access/acl
DELETE /access/acl

Tickets

POST /access/ticket

Pool Endpoints

List Pools

GET /pool
POST /pool

Pool Members

GET /pool/{poolid}
POST /pool/{poolid}
DELETE /pool/{poolid}/{vmid}

API Tokens

List Tokens

GET /access/users/{userid}/tokens
POST /access/users/{userid}/tokens
DELETE /access/users/{userid}/tokens/{tokenid}

Version Endpoints

API Version

GET /version

Network Endpoints

List Network

GET /nodes/{node}/network
POST /nodes/{node}/network
DELETE /nodes/{node}/network/{iface}

Firewall Endpoints

Firewall Rules

GET /nodes/{node}/firewall/rules
POST /nodes/{node}/firewall/rules

Firewall Aliases

GET /nodes/{node}/firewall/aliases
POST /nodes/{node}/firewall/aliases

Keywords

api rest endpoints reference qemu lxc storage cluster

Back to Proxmox VE

Graph View

Backlinks