Skip to main content Module lxc_api Copy item path Source LxcCloneVmError struct for typed errors of method lxc_clone_vm LxcCreateAliasError struct for typed errors of method lxc_create_alias LxcCreateIpError struct for typed errors of method lxc_create_ip LxcCreateIpsetError struct for typed errors of method lxc_create_ipset LxcCreateRuleError struct for typed errors of method lxc_create_rule LxcCreateVmError struct for typed errors of method lxc_create_vm LxcDeleteIpsetError struct for typed errors of method lxc_delete_ipset LxcDeleteRuleError struct for typed errors of method lxc_delete_rule LxcDelsnapshotError struct for typed errors of method lxc_delsnapshot LxcDestroyVmError struct for typed errors of method lxc_destroy_vm LxcGetAliasesError struct for typed errors of method lxc_get_aliases LxcGetFirewallError struct for typed errors of method lxc_get_firewall LxcGetIpsetError struct for typed errors of method lxc_get_ipset LxcGetOptionsError struct for typed errors of method lxc_get_options LxcGetRuleError struct for typed errors of method lxc_get_rule LxcGetRulesError struct for typed errors of method lxc_get_rules LxcGetSnapshotConfigError struct for typed errors of method lxc_get_snapshot_config LxcGetSnapshotError struct for typed errors of method lxc_get_snapshot LxcIpError struct for typed errors of method lxc_ip LxcIpsetIndexError struct for typed errors of method lxc_ipset_index LxcLogError struct for typed errors of method lxc_log LxcMigrateVmError struct for typed errors of method lxc_migrate_vm LxcMigrateVmPreconditionError struct for typed errors of method lxc_migrate_vm_precondition LxcMoveVolumeError struct for typed errors of method lxc_move_volume LxcMtunnelError struct for typed errors of method lxc_mtunnel LxcMtunnelwebsocketError struct for typed errors of method lxc_mtunnelwebsocket LxcReadAliasError struct for typed errors of method lxc_read_alias LxcReadIpError struct for typed errors of method lxc_read_ip LxcRefsError struct for typed errors of method lxc_refs LxcRemoteMigrateVmError struct for typed errors of method lxc_remote_migrate_vm LxcRemoveAliasError struct for typed errors of method lxc_remove_alias LxcRemoveIpError struct for typed errors of method lxc_remove_ip LxcResizeVmError struct for typed errors of method lxc_resize_vm LxcRollbackError struct for typed errors of method lxc_rollback LxcRrdError struct for typed errors of method lxc_rrd LxcRrddataError struct for typed errors of method lxc_rrddata LxcSetOptionsError struct for typed errors of method lxc_set_options LxcSnapshotCmdIdxError struct for typed errors of method lxc_snapshot_cmd_idx LxcSnapshotError struct for typed errors of method lxc_snapshot LxcSpiceproxyError struct for typed errors of method lxc_spiceproxy LxcTemplateError struct for typed errors of method lxc_template LxcTermproxyError struct for typed errors of method lxc_termproxy LxcUpdateAliasError struct for typed errors of method lxc_update_alias LxcUpdateIpError struct for typed errors of method lxc_update_ip LxcUpdateRuleError struct for typed errors of method lxc_update_rule LxcUpdateSnapshotConfigError struct for typed errors of method lxc_update_snapshot_config LxcUpdateVmError struct for typed errors of method lxc_update_vm LxcVmConfigError struct for typed errors of method lxc_vm_config LxcVmFeatureError struct for typed errors of method lxc_vm_feature LxcVmPendingError struct for typed errors of method lxc_vm_pending LxcVmRebootError struct for typed errors of method lxc_vm_reboot LxcVmResumeError struct for typed errors of method lxc_vm_resume LxcVmShutdownError struct for typed errors of method lxc_vm_shutdown LxcVmStartError struct for typed errors of method lxc_vm_start LxcVmStatusError struct for typed errors of method lxc_vm_status LxcVmStopError struct for typed errors of method lxc_vm_stop LxcVmSuspendError struct for typed errors of method lxc_vm_suspend LxcVmcmdidxError struct for typed errors of method lxc_vmcmdidx LxcVmdiridxError struct for typed errors of method lxc_vmdiridx LxcVmlistError struct for typed errors of method lxc_vmlist LxcVncproxyError struct for typed errors of method lxc_vncproxy LxcVncwebsocketError struct for typed errors of method lxc_vncwebsocket lxc_clone_vm Create a container clone/copy Permissions: You need ‘VM.Clone’ permissions on /vms/{vmid}, and ‘VM.Allocate’ permissions on /vms/{newid} (or on the VM pool /pool/{pool}). You also need ‘Datastore.AllocateSpace’ on any used storage, and ‘SDN.Use’ on any bridge. lxc_create_alias Create IP or Network Alias. lxc_create_ip Add IP or Network to IPSet. lxc_create_ipset Create new IPSet lxc_create_rule Create new rule. lxc_create_vm Create or restore a container. Permissions: You need ‘VM.Allocate’ permission on /vms/{vmid} or on the VM pool /pool/{pool}. For restore, it is enough if the user has ‘VM.Backup’ permission and the VM already exists. You also need ‘Datastore.AllocateSpace’ permissions on the storage. For privileged containers, ‘Sys.Modify’ permissions on ‘/’ are required. lxc_delete_ipset Delete IPSet lxc_delete_rule Delete rule. lxc_delsnapshot Delete a LXC snapshot. lxc_destroy_vm Destroy the container (also delete all uses files). lxc_get_aliases List aliases lxc_get_firewall Directory index. lxc_get_ipset List IPSet content lxc_get_options Get VM firewall options. lxc_get_rule Get single rule data. lxc_get_rules List rules. lxc_get_snapshot List all snapshots. lxc_get_snapshot_config Get snapshot configuration lxc_ip Get IP addresses of the specified container interface. lxc_ipset_index List IPSets lxc_log Read firewall log lxc_migrate_vm Migrate the container to another node. Creates a new migration task. lxc_migrate_vm_precondition Get preconditions for migration. lxc_move_volume Move a rootfs-/mp-volume to a different storage or to a different container. Permissions: You need ‘VM.Config.Disk’ permissions on /vms/{vmid}, and ‘Datastore.AllocateSpace’ permissions on the storage. To move a volume to another container, you need the permissions on the target container as well. lxc_mtunnel Migration tunnel endpoint - only for internal use by CT migration. Permissions: You need ‘VM.Allocate’ permissions on ‘/vms/{vmid}’ and Sys.Incoming on ‘/’. Further permission checks happen during the actual migration. lxc_mtunnelwebsocket Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration. Permissions: You need to pass a ticket valid for the selected socket. Tickets can be created via the mtunnel API call, which will check permissions accordingly. lxc_read_alias Read alias. lxc_read_ip Read IP or Network settings from IPSet. lxc_refs Lists possible IPSet/Alias reference which are allowed in source/dest properties. lxc_remote_migrate_vm Migrate the container to another cluster. Creates a new migration task. EXPERIMENTAL feature! lxc_remove_alias Remove IP or Network alias. lxc_remove_ip Remove IP or Network from IPSet. lxc_resize_vm Resize a container mount point. lxc_rollback Rollback LXC state to specified snapshot. lxc_rrd Read VM RRD statistics (returns PNG) lxc_rrddata Read VM RRD statistics lxc_set_options Set Firewall options. lxc_snapshot Snapshot a container. lxc_snapshot_cmd_idx lxc_spiceproxy Returns a SPICE configuration to connect to the CT. lxc_template Create a Template. Permissions: You need ‘VM.Allocate’ permissions on /vms/{vmid} lxc_termproxy Creates a TCP proxy connection. lxc_update_alias Update IP or Network alias. lxc_update_ip Update IP or Network settings lxc_update_rule Modify rule data. lxc_update_snapshot_config Update snapshot metadata. lxc_update_vm Set container options. Permissions: non-volume mount points in rootfs and mp[n] are restricted to root@pam lxc_vm_config Get container configuration. lxc_vm_feature Check if feature for virtual machine is available. lxc_vm_pending Get container configuration, including pending changes. lxc_vm_reboot Reboot the container by shutting it down, and starting it again. Applies pending changes. lxc_vm_resume Resume the container. lxc_vm_shutdown Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details. lxc_vm_start Start the container. lxc_vm_status Get virtual machine status. lxc_vm_stop Stop the container. This will abruptly stop all processes running in the container. lxc_vm_suspend Suspend the container. This is experimental. lxc_vmcmdidx Directory index lxc_vmdiridx Directory index lxc_vmlist LXC container index (per node). Permissions: Only list CTs where you have VM.Audit permission on /vms/. lxc_vncproxy Creates a TCP VNC proxy connections. lxc_vncwebsocket Opens a websocket for VNC traffic. Permissions: You also need to pass a valid ticket (vncticket). Wire-level note: this endpoint answers HTTP 101 Upgrade, not a JSON body. The 200 schema below is the apidoc-declared shape for tooling, but real clients perform a WebSocket upgrade and exchange framed messages on the resulting socket. See the x-pve-websocket extension for the framing and the list of sibling endpoints that issue tickets.