Preparing search index...
The search index is not available
proxmox-api
proxmox-api
Proxmox
integer1_65535
Type alias integer1_65535
integer1_
65535
:
number
Optional port.
Minimum
1
Maximum
65535
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
proxmox-
api
Proxmox
Api
access
Acl
Read
Acl
access
Domains
Index
access
Groups
Index
access
Groups
Read
Group
access
Index
access
Openid
Index
access
Openid
Login
Login
access
Roles
Index
access
Roles
Read
Role
access
Tfa
Add
Tfa
Entry
access
Tfa
Get
Tfa
Entry
access
Tfa
List
Tfa
access
Tfa
List
User
Tfa
access
Tfa
Verify
Tfa
access
Ticket
Create
Ticket
access
Users
Index
access
Users
Read
User
access
Users
Tfa
Read
User
Tfa
Type
access
Users
Token
Generate
Token
access
Users
Token
Read
Token
access
Users
Token
Token
Index
access
Users
Token
Update
Token
Info
cluster
Acme
Account
Account
Index
cluster
Acme
Account
Get
Account
cluster
Acme
Challenge
Schema
Challengeschema
cluster
Acme
Directories
Get
Directories
cluster
Acme
Index
cluster
Acme
Plugins
Index
cluster
Backup
Included
Volumes
Get
Volume
Backup
Included
cluster
Backup
Index
cluster
Backup
Info
Index
cluster
Backup
Info
Not
Backed
Up
Get
Guests
Not
In
Backup
cluster
Ceph
Cephindex
cluster
Ceph
Flags
Get
All
Flags
cluster
Config
Index
cluster
Config
Join
Join
Info
cluster
Config
Nodes
Addnode
cluster
Config
Nodes
Nodes
cluster
Firewall
Aliases
Get
Aliases
cluster
Firewall
Groups
Get
Rule
cluster
Firewall
Groups
Get
Rules
cluster
Firewall
Groups
List
Security
Groups
cluster
Firewall
Index
cluster
Firewall
Ipset
Get
Ipset
cluster
Firewall
Ipset
Ipset
Index
cluster
Firewall
Macros
Get
Macros
cluster
Firewall
Options
Get
Options
cluster
Firewall
Refs
Refs
cluster
Firewall
Rules
Get
Rule
cluster
Firewall
Rules
Get
Rules
cluster
Ha
Groups
Index
cluster
Ha
Index
cluster
Ha
Resources
Index
cluster
Ha
Resources
Read
cluster
Ha
Status
Index
cluster
Index
cluster
Jobs
Index
cluster
Jobs
Schedule
Analyze
Schedule
Analyze
cluster
Log
Log
cluster
Metrics
Index
cluster
Metrics
Server
Server
Index
cluster
Replication
Index
cluster
Resources
Resources
cluster
Sdn
Controllers
Index
cluster
Sdn
Dns
Index
cluster
Sdn
Index
cluster
Sdn
Ipams
Index
cluster
Sdn
Vnets
Index
cluster
Sdn
Vnets
Subnets
Index
cluster
Sdn
Zones
Index
cluster
Status
Get
Status
cluster
Tasks
Tasks
nodes
Aplinfo
Aplinfo
nodes
Apt
Index
nodes
Apt
Repositories
Repositories
nodes
Apt
Update
List
Updates
nodes
Apt
Versions
Versions
nodes
Capabilities
Index
nodes
Capabilities
Qemu
Cpu
Index
nodes
Capabilities
Qemu
Machines
Types
nodes
Capabilities
Qemu
Qemu
Caps
Index
nodes
Ceph
Configdb
Configdb
nodes
Ceph
Fs
Index
nodes
Ceph
Index
nodes
Ceph
Log
Log
nodes
Ceph
Mds
Index
nodes
Ceph
Mgr
Index
nodes
Ceph
Mon
Listmon
nodes
Ceph
Pools
Getpool
nodes
Ceph
Pools
Lspools
nodes
Ceph
Rules
Rules
nodes
Certificates
Acme
Index
nodes
Certificates
Custom
Upload
Custom
Cert
nodes
Certificates
Index
nodes
Certificates
Info
Info
nodes
Disks
Directory
Index
nodes
Disks
Index
nodes
Disks
List
List
nodes
Disks
Lvm
Index
nodes
Disks
Lvmthin
Index
nodes
Disks
Smart
Smart
nodes
Disks
Zfs
Detail
nodes
Disks
Zfs
Index
nodes
Dns
Dns
nodes
Firewall
Index
nodes
Firewall
Log
Log
nodes
Firewall
Options
Get
Options
nodes
Firewall
Rules
Get
Rule
nodes
Firewall
Rules
Get
Rules
nodes
Hardware
Index
nodes
Hardware
Pci
Mdev
Mdevscan
nodes
Hardware
Pci
Pciindex
nodes
Hardware
Pci
Pciscan
nodes
Hardware
Usb
Usbscan
nodes
Hosts
Get
Etc
Hosts
nodes
Index
nodes
Index2
nodes
Lxc
Config
Vm
Config
nodes
Lxc
Feature
Vm
Feature
nodes
Lxc
Firewall
Aliases
Get
Aliases
nodes
Lxc
Firewall
Index
nodes
Lxc
Firewall
Ipset
Get
Ipset
nodes
Lxc
Firewall
Ipset
Ipset
Index
nodes
Lxc
Firewall
Log
Log
nodes
Lxc
Firewall
Options
Get
Options
nodes
Lxc
Firewall
Refs
Refs
nodes
Lxc
Firewall
Rules
Get
Rule
nodes
Lxc
Firewall
Rules
Get
Rules
nodes
Lxc
Pending
Vm
Pending
nodes
Lxc
Rrd
Rrd
nodes
Lxc
Rrddata
Rrddata
nodes
Lxc
Snapshot
List
nodes
Lxc
Snapshot
Snapshot
Cmd
Idx
nodes
Lxc
Spiceproxy
Spiceproxy
nodes
Lxc
Status
Current
Vm
Status
nodes
Lxc
Status
Vmcmdidx
nodes
Lxc
Termproxy
Termproxy
nodes
Lxc
Vm
nodes
Lxc
Vmdiridx
nodes
Lxc
Vncproxy
Vncproxy
nodes
Lxc
Vncwebsocket
Vncwebsocket
nodes
Netstat
Netstat
nodes
Network
Index
nodes
Network
Network
Config
nodes
Qemu
Agent
Exec
Exec
nodes
Qemu
Agent
Exec
Status
Exec
Status
nodes
Qemu
Agent
File
Read
File
Read
nodes
Qemu
Agent
Index
nodes
Qemu
Config
Vm
Config
nodes
Qemu
Feature
Vm
Feature
nodes
Qemu
Firewall
Aliases
Get
Aliases
nodes
Qemu
Firewall
Index
nodes
Qemu
Firewall
Ipset
Get
Ipset
nodes
Qemu
Firewall
Ipset
Ipset
Index
nodes
Qemu
Firewall
Log
Log
nodes
Qemu
Firewall
Options
Get
Options
nodes
Qemu
Firewall
Refs
Refs
nodes
Qemu
Firewall
Rules
Get
Rule
nodes
Qemu
Firewall
Rules
Get
Rules
nodes
Qemu
Migrate
Migrate
Vm
Precondition
nodes
Qemu
Pending
Vm
Pending
nodes
Qemu
Rrd
Rrd
nodes
Qemu
Rrddata
Rrddata
nodes
Qemu
Snapshot
Snapshot
Cmd
Idx
nodes
Qemu
Snapshot
Snapshot
List
nodes
Qemu
Spiceproxy
Spiceproxy
nodes
Qemu
Status
Current
Vm
Status
nodes
Qemu
Status
Vmcmdidx
nodes
Qemu
Termproxy
Termproxy
nodes
Qemu
Vm
nodes
Qemu
Vmdiridx
nodes
Qemu
Vncproxy
Vncproxy
nodes
Qemu
Vncwebsocket
Vncwebsocket
nodes
Query
Url
Metadata
Query
Url
Metadata
nodes
Replication
Index
nodes
Replication
Log
Read
Job
Log
nodes
Replication
Status
nodes
Rrd
Rrd
nodes
Rrddata
Rrddata
nodes
Scan
Cifs
Cifsscan
nodes
Scan
Glusterfs
Glusterfsscan
nodes
Scan
Index
nodes
Scan
Iscsi
Iscsiscan
nodes
Scan
Lvm
Lvmscan
nodes
Scan
Lvmthin
Lvmthinscan
nodes
Scan
Nfs
Nfsscan
nodes
Scan
Pbs
Pbsscan
nodes
Scan
Zfs
Zfsscan
nodes
Sdn
Sdnindex
nodes
Sdn
Zones
Content
Index
nodes
Sdn
Zones
Diridx
nodes
Sdn
Zones
Index
nodes
Services
Index
nodes
Services
Srvcmdidx
nodes
Spiceshell
Spiceshell
nodes
Storage
Content
Index
nodes
Storage
Content
Info
nodes
Storage
Diridx
nodes
Storage
File
Restore
List
List
nodes
Storage
Index
nodes
Storage
Prunebackups
Dryrun
nodes
Storage
Rrd
Rrd
nodes
Storage
Rrddata
Rrddata
nodes
Syslog
Syslog
nodes
Tasks
Log
Read
Task
Log
nodes
Tasks
Node
Tasks
nodes
Tasks
Status
Read
Task
Status
nodes
Tasks
Upid
Index
nodes
Termproxy
Termproxy
nodes
Time
Time
nodes
Version
Version
nodes
Vncshell
Vncshell
nodes
Vncwebsocket
Vncwebsocket
nodes
Vzdump
Defaults
Defaults
pools
Index
pools
Read
Pool
storage
Create
storage
Index
storage
Update
version
Version
CIDR
CIDR_
1
CIDRv4
CIDRv6
IPorCIDR
IPorCIDRor
Alias
String0_
1024
String0_
128
String0_
2048
String0_
255
String0_
256
String0_
40
String0_
4096
String0_
512
String0_
61440
String0_
64
String0_
65536
String0_
80
String0_
8192
String5_
1024
String5_
64
Tacme
Tacmedomain
Taction
Tagent
Talias
Tapi
Tapplication
Tarch
Tarch_
1
Taudio0
Tbase_
dn
Tbios
Tbond_
mode
Tbond_
xmit_
hash_
policy
Tbwlimit
Tcf
Tchecksumalgorithm
Tcitype
Tcmd
Tcmode
Tcommand
Tcommand_
1
Tcompress
Tcompression
Tconsole
Tcpulimit
Tcpulimit_
1
Tcrush_
rule
Tdirectory
Tdisk
Tdisk_
1
Tdisk_
2
Tdisk_
3
Tdomain
Tefidisk0
Tfeature
Tfeatures
Tfencing
Tfilesystem
Tfingerprint
Tformat
Tformat_
1
Tgroup
Tha
Thttp_
proxy
Thugepages
Tide
Tinfluxdbproto
Tivshmem
Tkey
Tkeyboard
Tlanguage
Tlink
Tlock
Tlock_
1
Tlog
Tlog_
ratelimit
Tmachine
Tmailnotification
Tmigrate_
downtime
Tmigration
Tmigration_
type
Tmode
Tmode_
1
Tmp
Tname
Tname_
1
Tnet
Tnet_
1
Tnuma
Tostype
Tostype_
1
Tparallel
Tpassword
Tpg_
autoscale_
mode
Tpolicy_
in
Tpreallocation
Tproperty
Tproto
Traidlevel
Trate
Tremove_
job
Trng0
Trootfs
Tsata
Tscope
Tscope_
1
Tscsi
Tscsihw
Tserial
Tserial_
1
Tservice
Tservice_
1
Tsince
Tsize
Tsize_
1
Tsmbversion
Tsource
Tspice_
enhancements
Tsslversion
Tstartdate
Tstarttime
Tstate
Tsync_
attributes
Ttarget_
size
Ttarget_
size_
ratio
Ttargetvolume
Ttimeframe
Ttpmstate0
Ttransport
Ttype
Ttype_
1
Ttype_
10
Ttype_
11
Ttype_
12
Ttype_
13
Ttype_
14
Ttype_
15
Ttype_
16
Ttype_
17
Ttype_
18
Ttype_
19
Ttype_
2
Ttype_
20
Ttype_
3
Ttype_
4
Ttype_
5
Ttype_
6
Ttype_
7
Ttype_
8
Ttype_
9
Tu2f
Tunused
Tunused_
1
Turl
Tusb
Tuser_
attr
Tuserid
Tusernameclaim
Tuuid
Tvg
Tvga
Tvirtio
Tvlanprotocol
Tvmgenid
Twal_
dev_
size
Twebauthn
address
address_
1
addresslist
dnsname
dnsname_
1
dnsnamelist
emaillist
emailopt
emailorusernamelist
graphitepath
integer
integer0_
128
integer0_
172800
integer0_
300
integer0_
50000
integer0_
500000
integer0_
6
integer0_
8
integer1280_
65520
integer16_
2160
integer16_
4096
integer1_
100
integer1_
30
integer1_
32768
integer1_
4094
integer1_
65535
integer1_
65536
integer1_
7
integer1_
7_
1
integer1_
7_
2
integer1_
8192
integer2_
262144
integer30_
60
integer512_
65536
integer5900_
5999
integer6_
14
integer8_
32768
integer9_
16
integer
Max32768
integer_
Min0
integer_
Min1
integer_
Min16
integer_
Min32768
integer_
Min7875
ip
iplist
ipv4
ipv4mask
ipv6
ldapsimpleattr
ldapsimpleattrlist
lxcipwithllifacelist
macaddr
macprefix
pemcertificatechain
pemstring
prunebackups
pvecalendarevent
pveconfigid
pveconfigid_
1
pveconfigid_
2
pveconfigid_
3
pveconfigid_
4
pveconfigid_
5
pveconfigid_
6
pveconfigidlist
pveconfigidlist_
1
pvecttimezone
pvedayofweeklist
pvefwaddrspec
pvefwdportspec
pvefwicmptypespec
pvefwprotocolspec
pvefwsportspec
pvegroupid
pvegroupidlist
pvehagroupnodelist
pveharesourceorvmid
pvehotplugfeatures
pveiface
pveiface_
1
pveifacelist
pvenode
pvenode_
1
pvenodelist
pvepoolid
pveprivlist
pveprivlist_
1
pveqmboot
pveqmbootdisk
pveqmcicustom
pveqmhostpci
pveqmide
pveqmipconfig
pveqmsmbios1
pveqmwatchdog
pverealm
pvereplicationjobid
pveroleid
pveroleidlist
pvesdncontrollerid
pvesdndnsid
pvesdnipamid
pvesdnsubnetid
pvesdnvnetid
pvesdnzoneid
pvestartuporder
pvestoragecontent
pvestoragecontent_
1
pvestoragecontentlist
pvestorageformat
pvestorageid
pvestorageidlist
pvestorageoptions
pvestoragepath
pvestorageportaldns
pvestorageportaldnslist
pvestorageserver
pvestoragevgname
pvetaglist
pvetaskstatustypelist
pvetfaconfig
pvetokenidlist
pveuserid
pveuseridlist
pvevmcpuconf
pvevmid
pvevmidlist
pvevolumeid
realmsyncoptions
storagepairlist
stringalist
stringlist
urlencoded
Generated using
TypeDoc
Optional port.
Minimum
1
Maximum
65535