Implemented endpoints

This is a development-purposed list to keep track of the implemented proxmox endpoints as a callable golang func but not necessarily as a CLI command.

Symbol	Description
	Not implemented
	Partially implemented (notes will be added in the docs)
	Fully implemented

PVE Core

Path	GET	POST	PUT	DELETE
/version

Access

Path	GET	POST	PUT	DELETE
/access/acl
/access/password
/access/permissions
/access/ticket

Users

Path	GET	POST	PUT	DELETE
/access/users
/access/users/:userId
/access/users/:userId/tfa
/access/users/:userId/unlock-tfa
/access/users/:userId/token
/access/users/:userId/token/:tokenId

TFA

Path	GET	POST	PUT	DELETE
/access/tfa
/access/tfa/:userId
/access/tfa/:userId/:id

Roles

Path	GET	POST	PUT	DELETE
/access/roles
/access/roles/:roleId

OpenId

Path	GET	POST	PUT	DELETE
/access/openid/auth-url
/access/openid/login

Groups

Path	GET	POST	PUT	DELETE
/access/groups
/access/groups/:groupId

Domains

Path	GET	POST	PUT	DELETE
/access/domains
/access/domains/:realmId
/access/domains/:realmId/sync

Cluster

Path	GET	POST	PUT	DELETE
/cluster
/cluster/log
/cluster/nextid
/cluster/options
/cluster/resources
/cluster/status
/cluster/tasks

Acme

Path	GET	POST	PUT	DELETE
/cluster/acme
/cluster/acme/challenge-schema
/cluster/acme/directories
/cluster/acme/meta
/cluster/acme/tos
/cluster/acme/account
/cluster/acme/account/:name
/cluster/acme/plugins
/cluster/acme/plugins/:id

Backup

Path	GET	POST	PUT	DELETE
/cluster/backup
/cluster/backup/:id
/cluster/backup/:id/included_volumes

Backup info

path	get	post	put	delete
/cluster/backup-info
/cluster/backup-info/not-backed-up

Ceph

path	get	post	put	delete
/cluster/ceph
/cluster/ceph/metadata
/cluster/ceph/status
/cluster/ceph/flags
/cluster/ceph/flags/:flag

Config

path	get	post	put	delete
/cluster/config
/cluster/config/apiversion
/cluster/config/join
/cluster/config/qdevice
/cluster/config/totem
/cluster/config/nodes
/cluster/config/nodes/:node

Firewall

path	get	post	put	delete
/cluster/firewall
/cluster/firewall/macros
/cluster/firewall/options
/cluster/firewall/refs
/cluster/firewall/aliases
/cluster/firewall/aliases/:name
/cluster/firewall/groups
/cluster/firewall/groups/:group
/cluster/firewall/groups/:group/:pos
/cluster/firewall/ipset
/cluster/firewall/ipset/:name
/cluster/firewall/ipset/:name/:cidr
/cluster/firewall/rules
/cluster/firewall/rules/:pos

High availability

path	get	post	put	delete
/cluster/ha
/cluster/ha/groups
/cluster/ha/groups/:group
/cluster/ha/resources
/cluster/ha/resources/:sid
/cluster/ha/resources/:sid/migrate
/cluster/ha/resources/:sid/relocate
/cluster/ha/status
/cluster/ha/status/current
/cluster/ha/status/manager_status

Jobs

path	get	post	put	delete
/cluster/jobs
/cluster/jobs/schedule-analyze
/cluster/jobs/realm-sync
/cluster/jobs/realm-sync/:id

Mapping

path	get	post	put	delete
/cluster/mapping
/cluster/mapping/pci
/cluster/mapping/pci/:id
/cluster/mapping/usb
/cluster/mapping/usb/:id

Metrics

path	get	post	put	delete
/cluster/metrics
/cluster/metrics/export
/cluster/metrics/server
/cluster/metrics/server/:id

Notifications

path	get	post	put	delete
/cluster/notifications
/cluster/notifications/matcher-field-values
/cluster/notifications/matcher-fields
/cluster/notifications/endpoints
/cluster/notifications/endpoints/gotify
/cluster/notifications/endpoints/gotify/:name
/cluster/notifications/endpoints/sendmail
/cluster/notifications/endpoints/sendmail/:name
/cluster/notifications/endpoints/smpt
/cluster/notifications/endpoints/smpt/:name
/cluster/notifications/endpoints/webhook
/cluster/notifications/endpoints/webhook/:name
/cluster/notifications/matchers
/cluster/notifications/matchers/:name
/cluster/notifications/targets
/cluster/notifications/targets/:name

Replication

path	get	post	put	delete
/cluster/replication
/cluster/replication/:id

SDN

path	get	post	put	delete
/cluster/sdn
/cluster/sdn/controllers
/cluster/sdn/controllers/:controller
/cluster/sdn/dns
/cluster/sdn/dns/:dns
/cluster/sdn/ipams
/cluster/sdn/ipams/:ipam
/cluster/sdn/vnets
/cluster/sdn/vnets/:vnet
/cluster/sdn/vnets/:vnet/ips
/cluster/sdn/vnets/:vnet/firewall
/cluster/sdn/vnets/:vnet/firewall/options
/cluster/sdn/vnets/:vnet/firewall/rules
/cluster/sdn/vnets/:vnet/firewall/rules/:pos
/cluster/sdn/vnets/:vnet/subnets
/cluster/sdn/vnets/:vnet/subnets/:subnet
/cluster/sdn/zones
/cluster/sdn/zones/:zone

Nodes

Path	GET	POST	PUT	DELETE
/nodes
/nodes/:node
/nodes/:node/aplinfo
/nodes/:node/config
/nodes/:node/dns
/nodes/:node/execute
/nodes/:node/hosts
/nodes/:node/journal
/nodes/:node/migrateall
/nodes/:node/netstat
/nodes/:node/query-url-metadata
/nodes/:node/report
/nodes/:node/rrd
/nodes/:node/rrddata
/nodes/:node/spiceshell
/nodes/:node/startall
/nodes/:node/status
/nodes/:node/stopall
/nodes/:node/subscription
/nodes/:node/suspendall
/nodes/:node/syslog
/nodes/:node/termproxy
/nodes/:node/time
/nodes/:node/version
/nodes/:node/vncshell
/nodes/:node/vncwebsocket
/nodes/:node/wakeonlan

Node: apt

Path	GET	POST	PUT	DELETE
/nodes/:node/apt
/nodes/:node/apt/changelog
/nodes/:node/apt/repositories
/nodes/:node/apt/update
/nodes/:node/apt/versions

Node: Capabilities

Path	GET	POST	PUT	DELETE
/nodes/:node/capabilities
/nodes/:node/capabilities/qemu
/nodes/:node/capabilities/qemu/cpu
/nodes/:node/capabilities/qemu/machines

Node: ceph

Path	GET	POST	PUT	DELETE
/nodes/:node/ceph
/nodes/:node/ceph/cmd-safety
/nodes/:node/ceph/crush
/nodes/:node/ceph/init
/nodes/:node/ceph/log
/nodes/:node/ceph/restart
/nodes/:node/ceph/rules
/nodes/:node/ceph/start
/nodes/:node/ceph/status
/nodes/:node/ceph/stop
/nodes/:node/ceph/cfg
/nodes/:node/ceph/cfg/db
/nodes/:node/ceph/cfg/raw
/nodes/:node/ceph/cfg/value
/nodes/:node/ceph/fs
/nodes/:node/ceph/fs/:name
/nodes/:node/ceph/mds
/nodes/:node/ceph/mds/:name
/nodes/:node/ceph/mgr
/nodes/:node/ceph/mgr/:id
/nodes/:node/ceph/mon
/nodes/:node/ceph/mon/:monid
/nodes/:node/ceph/osd
/nodes/:node/ceph/osd/:osdid
/nodes/:node/ceph/osd/:osdid/in
/nodes/:node/ceph/osd/:osdid/lv-info
/nodes/:node/ceph/osd/:osdid/metadata
/nodes/:node/ceph/osd/:osdid/out
/nodes/:node/ceph/osd/:osdid/scrub
/nodes/:node/ceph/pool
/nodes/:node/ceph/pool/:name
/nodes/:node/ceph/pool/:name/status

Node: Certificates

Path	GET	POST	PUT	DELETE
/nodes/:node/certificates
/nodes/:node/certificates/custom
/nodes/:node/certificates/info
/nodes/:node/certificates/acme
/nodes/:node/certificates/acme/certificate

Node: Disks

Path	GET	POST	PUT	DELETE
/nodes/:node/disks
/nodes/:node/disks/directory
/nodes/:node/disks/directory/:name
/nodes/:node/disks/lvm
/nodes/:node/disks/lvm/:name
/nodes/:node/disks/lvmthin
/nodes/:node/disks/lvmthin/:name
/nodes/:node/disks/zfs
/nodes/:node/disks/zfs/:name
/nodes/:node/disks/initgpt
/nodes/:node/disks/list
/nodes/:node/disks/smart
/nodes/:node/disks/wipedisk

Node: Firewall

Path	GET	POST	PUT	DELETE
/nodes/:node/firewall
/nodes/:node/firewall/rules
/nodes/:node/firewall/rules/:pos
/nodes/:node/firewall/log
/nodes/:node/firewall/options

Node: Hardware

Path	GET	POST	PUT	DELETE
/nodes/:node/hardware
/nodes/:node/hardware/pci/:pci-id-or-mapping
/nodes/:node/hardware/pci/:pci-id-or-mapping/mdev
/nodes/:node/hardware/usb

Node: lxc

Path	GET	POST	PUT	DELETE
/nodes/:node/lxc
/nodes/:node/lxc/:vmid
/nodes/:node/lxc/:vmid/firewall
/nodes/:node/lxc/:vmid/firewall/log
/nodes/:node/lxc/:vmid/firewall/option
/nodes/:node/lxc/:vmid/firewall/refs
/nodes/:node/lxc/:vmid/firewall/aliases
/nodes/:node/lxc/:vmid/firewall/aliases/:name
/nodes/:node/lxc/:vmid/firewall/ipset
/nodes/:node/lxc/:vmid/firewall/ipset/:name
/nodes/:node/lxc/:vmid/firewall/ipset/:name/:cidr
/nodes/:node/lxc/:vmid/firewall/rules
/nodes/:node/lxc/:vmid/firewall/rules/:pos
/nodes/:node/lxc/:vmid/snapshot
/nodes/:node/lxc/:vmid/snapshot/:name
/nodes/:node/lxc/:vmid/snapshot/:name/config
/nodes/:node/lxc/:vmid/snapshot/:name/rollback
/nodes/:node/lxc/:vmid/status
/nodes/:node/lxc/:vmid/status/current
/nodes/:node/lxc/:vmid/status/reboot
/nodes/:node/lxc/:vmid/status/resume
/nodes/:node/lxc/:vmid/status/shutdown
/nodes/:node/lxc/:vmid/status/start
/nodes/:node/lxc/:vmid/status/stop
/nodes/:node/lxc/:vmid/status/suspend
/nodes/:node/lxc/:vmid/clone
/nodes/:node/lxc/:vmid/config
/nodes/:node/lxc/:vmid/feature
/nodes/:node/lxc/:vmid/interfaces
/nodes/:node/lxc/:vmid/migrate
/nodes/:node/lxc/:vmid/move_volume
/nodes/:node/lxc/:vmid/mtunnel
/nodes/:node/lxc/:vmid/mtunnelwebsocket
/nodes/:node/lxc/:vmid/pending
/nodes/:node/lxc/:vmid/remote_migrate
/nodes/:node/lxc/:vmid/rdd
/nodes/:node/lxc/:vmid/rdddata
/nodes/:node/lxc/:vmid/spiceproxy
/nodes/:node/lxc/:vmid/template
/nodes/:node/lxc/:vmid/termproxy
/nodes/:node/lxc/:vmid/vncproxy
/nodes/:node/lxc/:vmid/vncwebsocket

Node: Network

Path	GET	POST	PUT	DELETE
/nodes/:node/network
/nodes/:node/network/:iface

Node: qemu

Path	GET	POST	PUT	DELETE
/nodes/:node/qemu
/nodes/:node/qemu/:vmid
/nodes/:node/qemu/:vmid/agent
/nodes/:node/qemu/:vmid/agent/exec
/nodes/:node/qemu/:vmid/agent/exec-status
/nodes/:node/qemu/:vmid/agent/file-read
/nodes/:node/qemu/:vmid/agent/file-write
/nodes/:node/qemu/:vmid/agent/fsfreeze-freeze
/nodes/:node/qemu/:vmid/agent/fsfreeze-status
/nodes/:node/qemu/:vmid/agent/fsfreeze-thaw
/nodes/:node/qemu/:vmid/agent/fstrim
/nodes/:node/qemu/:vmid/agent/get-fsinfo
/nodes/:node/qemu/:vmid/agent/get-host-name
/nodes/:node/qemu/:vmid/agent/get-memory-block-info
/nodes/:node/qemu/:vmid/agent/get-memory-blocks
/nodes/:node/qemu/:vmid/agent/get-osinfo
/nodes/:node/qemu/:vmid/agent/get-time
/nodes/:node/qemu/:vmid/agent/get-timezone
/nodes/:node/qemu/:vmid/agent/get-users
/nodes/:node/qemu/:vmid/agent/get-vcpus
/nodes/:node/qemu/:vmid/agent/info
/nodes/:node/qemu/:vmid/agent/network-get-interfaces
/nodes/:node/qemu/:vmid/agent/set-user-password
/nodes/:node/qemu/:vmid/agent/shutdown
/nodes/:node/qemu/:vmid/agent/suspend-disk
/nodes/:node/qemu/:vmid/agent/suspend-hybrid
/nodes/:node/qemu/:vmid/agent/suspend-ram
/nodes/:node/qemu/:vmid/cloudinit
/nodes/:node/qemu/:vmid/cloudinit/dump
/nodes/:node/qemu/:vmid/firewall
/nodes/:node/qemu/:vmid/firewall/log
/nodes/:node/qemu/:vmid/firewall/option
/nodes/:node/qemu/:vmid/firewall/refs
/nodes/:node/qemu/:vmid/firewall/aliases
/nodes/:node/qemu/:vmid/firewall/aliases/:name
/nodes/:node/qemu/:vmid/firewall/ipset
/nodes/:node/qemu/:vmid/firewall/ipset/:name
/nodes/:node/qemu/:vmid/firewall/ipset/:name/:cidr
/nodes/:node/qemu/:vmid/firewall/rules
/nodes/:node/qemu/:vmid/firewall/rules/:pos
/nodes/:node/qemu/:vmid/snapshot
/nodes/:node/qemu/:vmid/snapshot/:snapname
/nodes/:node/qemu/:vmid/snapshot/:snapname/config
/nodes/:node/qemu/:vmid/snapshot/:snapname/rollback
/nodes/:node/qemu/:vmid/status
/nodes/:node/qemu/:vmid/status/current
/nodes/:node/qemu/:vmid/status/reboot
/nodes/:node/qemu/:vmid/status/reset
/nodes/:node/qemu/:vmid/status/resume
/nodes/:node/qemu/:vmid/status/shutdown
/nodes/:node/qemu/:vmid/status/start
/nodes/:node/qemu/:vmid/status/stop
/nodes/:node/qemu/:vmid/status/suspend
/nodes/:node/qemu/:vmid/clone
/nodes/:node/qemu/:vmid/config
/nodes/:node/qemu/:vmid/feature
/nodes/:node/qemu/:vmid/migrate
/nodes/:node/qemu/:vmid/monitor
/nodes/:node/qemu/:vmid/move_disk
/nodes/:node/qemu/:vmid/mtunnel
/nodes/:node/qemu/:vmid/mtunnelwebsocket
/nodes/:node/qemu/:vmid/pending
/nodes/:node/qemu/:vmid/remote_migrate
/nodes/:node/qemu/:vmid/resize
/nodes/:node/qemu/:vmid/rrd
/nodes/:node/qemu/:vmid/rrddata
/nodes/:node/qemu/:vmid/sendkey
/nodes/:node/qemu/:vmid/spicyproxy
/nodes/:node/qemu/:vmid/template
/nodes/:node/qemu/:vmid/termproxy
/nodes/:node/qemu/:vmid/unlink
/nodes/:node/qemu/:vmid/vncproxy
/nodes/:node/qemu/:vmid/vncwebsocket

Node: Replication

Path	GET	POST	PUT	DELETE
/nodes/:node/replication
/nodes/:node/replication/:id
/nodes/:node/replication/:id/log
/nodes/:node/replication/:id/schedule_now
/nodes/:node/replication/:id/status

Node: Scan

Path	GET	POST	PUT	DELETE
/nodes/:node/scan
/nodes/:node/scan/cifs
/nodes/:node/scan/gluterfs
/nodes/:node/scan/iscsi
/nodes/:node/scan/lvm
/nodes/:node/scan/lvmthin
/nodes/:node/scan/nfs
/nodes/:node/scan/pbs
/nodes/:node/scan/zfs

Node: sdn

Path	GET	POST	PUT	DELETE
/nodes/:node/sdn
/nodes/:node/sdn/zones
/nodes/:node/sdn/zones/:zone
/nodes/:node/sdn/zones/:zone/content

Node: Services

Path	GET	POST	PUT	DELETE
/nodes/:node/services
/nodes/:node/services/:service
/nodes/:node/services/:service/reload
/nodes/:node/services/:service/restart
/nodes/:node/services/:service/start
/nodes/:node/services/:service/state
/nodes/:node/services/:service/stop

Node: Storage

Path	GET	POST	PUT	DELETE
/nodes/:node/storage
/nodes/:node/storage/:storage
/nodes/:node/storage/:storage/content
/nodes/:node/storage/:storage/content/:volume
/nodes/:node/storage/:storage/file-restore
/nodes/:node/storage/:storage/file-restore/download
/nodes/:node/storage/:storage/file-restore/list
/nodes/:node/storage/:storage/download-url
/nodes/:node/storage/:storage/import-metadata
/nodes/:node/storage/:storage/prunebackups
/nodes/:node/storage/:storage/rdd
/nodes/:node/storage/:storage/rdddata
/nodes/:node/storage/:storage/status
/nodes/:node/storage/:storage/upload

Node: Tasks

Path	GET	POST	PUT	DELETE
/nodes/:node/tasks
/nodes/:node/tasks/:upid
/nodes/:node/tasks/:upid/log
/nodes/:node/tasks/:upid/status

Node: VZDump

Path	GET	POST	PUT	DELETE
/nodes/:node/vzdump
/nodes/:node/vzdump/defaults
/nodes/:node/vzdump/extractconfig

Pools

Path	GET	POST	PUT	DELETE
/pools
/pools/:poolid

Storage

Path	GET	POST	PUT	DELETE
/storage
/storage/:storage