package
0.0.0-20220810114945-f1bce5602278
Repository: https://github.com/r3dsh/proxmox-api.git
Documentation: pkg.go.dev
# Functions
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
AccessAclReadResponse acl Get Access Control List (ACLs).
AccessAclUpdateRequest acl - Update Access Control List (add or remove permissions).
AccessDomainsCreateRequest domains - Add an authentication server.
AccessDomainsDeleteRequest {realm} - Delete an authentication server.
AccessDomainsReadRequest {realm} - Get auth server configuration.
AccessDomainsSyncRequest sync - Syncs users and/or groups from the configured LDAP to user.cfg.
AccessDomainsUpdateRequest {realm} - Update authentication server settings.
AccessGroupsCreateGroupRequest groups - Create new group.
AccessGroupsDeleteGroupRequest {groupid} - Delete group.
AccessGroupsReadGroupRequest {groupid} - Get group configuration.
AccessGroupsReadGroupResponse {groupid} Get group configuration.
AccessGroupsUpdateGroupRequest {groupid} - Update group data.
AccessOpenidAuthUrlAuthUrlRequest auth-url - Get the OpenId Authorization Url for the specified realm.
AccessOpenidLoginRequest login - Verify OpenID authorization code and create a ticket.
AccessOpenidLoginResponse login Verify OpenID authorization code and create a ticket.
AccessPasswordChangeRequest password - Change user password.
AccessPermissionsRequest permissions - Retrieve effective permissions of given user/token.
AccessRolesCreateRoleRequest roles - Create new role.
AccessRolesDeleteRoleRequest {roleid} - Delete role.
AccessRolesReadRoleRequest {roleid} - Get role configuration.
AccessRolesReadRoleResponse {roleid} Get role configuration.
AccessRolesUpdateRoleRequest {roleid} - Update an existing role.
AccessTfaAddEntryRequest {userid} - Add a TFA entry for a user.
AccessTfaAddEntryResponse {userid} Add a TFA entry for a user.
AccessTfaDeleteRequest {id} - Delete a TFA entry by ID.
AccessTfaGetEntryRequest {id} - Fetch a requested TFA entry if present.
AccessTfaGetEntryResponse {id} Fetch a requested TFA entry if present.
AccessTfaListResponse tfa List TFA configurations of users.
AccessTfaListUserRequest {userid} - List TFA configurations of users.
AccessTfaListUserResponse {userid} List TFA configurations of users.
AccessTfaUpdateEntryRequest {id} - Add a TFA entry for a user.
AccessTfaVerifyRequest tfa - Finish a u2f challenge.
AccessTfaVerifyResponse tfa Finish a u2f challenge.
AccessTicketCreateRequest ticket - Create or verify authentication ticket.
AccessTicketCreateResponse ticket Create or verify authentication ticket.
AccessUsersCreateUserRequest users - Create new user.
AccessUsersDeleteUserRequest {userid} - Delete user.
AccessUsersReadUserRequest {userid} - Get user configuration.
AccessUsersReadUserResponse {userid} Get user configuration.
AccessUsersTfaReadUserTypeRequest tfa - Get user TFA types (Personal and Realm).
AccessUsersTfaReadUserTypeResponse tfa Get user TFA types (Personal and Realm).
AccessUsersTokenGenerateRequest {tokenid} - Generate a new API token for a specific user.
AccessUsersTokenGenerateResponse {tokenid} Generate a new API token for a specific user.
AccessUsersTokenIndexRequest token - Get user API tokens.
AccessUsersTokenIndexResponse token Get user API tokens.
AccessUsersTokenReadRequest {tokenid} - Get specific API token information.
AccessUsersTokenReadResponse {tokenid} Get specific API token information.
AccessUsersTokenRemoveRequest {tokenid} - Remove API token for a specific user.
AccessUsersTokenUpdateInfoRequest {tokenid} - Update API token for a specific user.
AccessUsersTokenUpdateInfoResponse {tokenid} Update API token for a specific user.
AccessUsersUpdateUserRequest {userid} - Update user configuration.
No description provided by the author
ClusterAcmeAccountDeactivateRequest {name} - Deactivate existing ACME account at CA.
ClusterAcmeAccountGetRequest {name} - Return existing ACME account information.
ClusterAcmeAccountGetResponse {name} Return existing ACME account information.
ClusterAcmeAccountRegisterRequest account - Register a new ACME account with CA.
ClusterAcmeAccountUpdateRequest {name} - Update existing ACME account information with CA.
ClusterAcmeChallengeSchemaChallengeschemaResponse challenge-schema Get schema of ACME challenge types.
ClusterAcmeDirectoriesGetResponse directories Get named known ACME directory endpoints.
ClusterAcmePluginsAddPluginRequest plugins - Add ACME plugin configuration.
ClusterAcmePluginsDeletePluginRequest {id} - Delete ACME plugin configuration.
ClusterAcmePluginsGetPluginConfigRequest {id} - Get ACME plugin configuration.
ClusterAcmePluginsUpdatePluginRequest {id} - Update ACME plugin configuration.
ClusterAcmeTosGetRequest tos - Retrieve ACME TermsOfService URL from CA.
ClusterBackupCreateJobRequest backup - Create new vzdump backup job.
ClusterBackupDeleteJobRequest {id} - Delete vzdump backup job definition.
ClusterBackupIncludedVolumesGetVolumeBackupIncludedRequest included_volumes - Returns included guests and the backup status of their disks.
ClusterBackupIncludedVolumesGetVolumeBackupIncludedResponse included_volumes Returns included guests and the backup status of their disks.
ClusterBackupInfoNotBackedUpGetGuestsNotInBackupResponse not-backed-up Shows all guests which are not covered by any backup job.
ClusterBackupReadJobRequest {id} - Read vzdump backup job definition.
ClusterBackupUpdateJobRequest {id} - Update vzdump backup job definition.
ClusterCephFlagsGetAllResponse flags get the status of all ceph flags https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/ceph/flags
.
ClusterCephFlagsGetFlagRequest {flag} - Get the status of a specific ceph flag.
ClusterCephFlagsSetRequest flags - Set/Unset multiple ceph flags at once.
ClusterCephFlagsUpdateFlagRequest {flag} - Set or clear (unset) a specific ceph flag Set or clear (unset) a specific ceph flag https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/ceph/flags/{flag}
.
ClusterCephMetadataRequest metadata - Get ceph metadata.
ClusterConfigCreateRequest config - Generate new cluster configuration.
ClusterConfigJoinInfoRequest join - Get information needed to join this cluster over the connected node.
ClusterConfigJoinInfoResponse join Get information needed to join this cluster over the connected node.
ClusterConfigJoinRequest join - Joins this node into an existing cluster.
ClusterConfigNodesAddnodeRequest {node} - Adds a node to the cluster configuration.
ClusterConfigNodesAddnodeResponse {node} Adds a node to the cluster configuration.
ClusterConfigNodesDelnodeRequest {node} - Removes a node from the cluster configuration.
ClusterConfigNodesResponse nodes Corosync node list.
ClusterFirewallAliasesCreateAliasRequest aliases - Create IP or Network Alias.
ClusterFirewallAliasesGetResponse aliases List aliases https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/firewall/aliases
.
ClusterFirewallAliasesReadAliasRequest {name} - Read alias.
ClusterFirewallAliasesRemoveAliasRequest {name} - Remove IP or Network alias.
ClusterFirewallAliasesUpdateAliasRequest {name} - Update IP or Network alias.
ClusterFirewallGroupsCreateRuleRequest {group} - Create new rule.
ClusterFirewallGroupsCreateSecurityGroupRequest groups - Create new security group.
ClusterFirewallGroupsDeleteRuleRequest {pos} - Delete rule.
ClusterFirewallGroupsDeleteSecurityGroupRequest {group} - Delete security group.
ClusterFirewallGroupsGetRuleRequest {pos} - Get single rule data.
ClusterFirewallGroupsGetRuleResponse {pos} Get single rule data.
ClusterFirewallGroupsGetRulesRequest {group} - List rules.
ClusterFirewallGroupsGetRulesResponse {group} List rules.
ClusterFirewallGroupsListSecurityResponse groups List security groups.
ClusterFirewallGroupsUpdateRuleRequest {pos} - Modify rule data.
ClusterFirewallIpsetCreateIpRequest {name} - Add IP or Network to IPSet.
ClusterFirewallIpsetCreateRequest ipset - Create new IPSet Create new IPSet https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/firewall/ipset
.
ClusterFirewallIpsetDeleteRequest {name} - Delete IPSet Delete IPSet https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/firewall/ipset/{name}
.
ClusterFirewallIpsetGetRequest {name} - List IPSet content List IPSet content https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/firewall/ipset/{name}
.
ClusterFirewallIpsetGetResponse {name} List IPSet content https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/firewall/ipset/{name}
.
ClusterFirewallIpsetIndexResponse ipset List IPSets https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/firewall/ipset
.
ClusterFirewallIpsetReadIpRequest {cidr} - Read IP or Network settings from IPSet.
ClusterFirewallIpsetRemoveIpRequest {cidr} - Remove IP or Network from IPSet.
ClusterFirewallIpsetUpdateIpRequest {cidr} - Update IP or Network settings Update IP or Network settings https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/firewall/ipset/{name}/{cidr}
.
ClusterFirewallMacrosGetResponse macros List available macros https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/firewall/macros
.
ClusterFirewallOptionsGetResponse options Get Firewall options.
ClusterFirewallOptionsSetRequest options - Set Firewall options.
ClusterFirewallRefsRequest refs - Lists possible IPSet/Alias reference which are allowed in source/dest properties.
ClusterFirewallRefsResponse refs Lists possible IPSet/Alias reference which are allowed in source/dest properties.
ClusterFirewallRulesCreateRuleRequest rules - Create new rule.
ClusterFirewallRulesDeleteRuleRequest {pos} - Delete rule.
ClusterFirewallRulesGetResponse rules List rules.
ClusterFirewallRulesGetRuleRequest {pos} - Get single rule data.
ClusterFirewallRulesGetRuleResponse {pos} Get single rule data.
ClusterFirewallRulesUpdateRuleRequest {pos} - Modify rule data.
ClusterHaGroupsCreateRequest groups - Create a new HA group.
ClusterHaGroupsDeleteRequest {group} - Delete ha group configuration.
ClusterHaGroupsReadRequest {group} - Read ha group configuration.
ClusterHaGroupsUpdateRequest {group} - Update ha group configuration.
ClusterHaResourcesCreateRequest resources - Create a new HA resource.
ClusterHaResourcesDeleteRequest {sid} - Delete resource configuration.
ClusterHaResourcesMigrateRequest migrate - Request resource migration (online) to another node.
ClusterHaResourcesReadRequest {sid} - Read resource configuration.
ClusterHaResourcesReadResponse {sid} Read resource configuration.
ClusterHaResourcesRelocateRequest relocate - Request resource relocatzion to another node.
ClusterHaResourcesUpdateRequest {sid} - Update resource configuration.
ClusterJobsScheduleAnalyzeRequest schedule-analyze - Returns a list of future schedule runtimes.
ClusterJobsScheduleAnalyzeResponse schedule-analyze Returns a list of future schedule runtimes.
ClusterLogRequest log - Read cluster log Read cluster log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/log
.
ClusterMetricsServerCreateRequest {id} - Create a new external metric server config Create a new external metric server config https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/metrics/server/{id}
.
ClusterMetricsServerDeleteRequest {id} - Remove Metric server.
ClusterMetricsServerIndexResponse server List configured metric servers.
ClusterMetricsServerReadRequest {id} - Read metric server configuration.
ClusterMetricsServerUpdateRequest {id} - Update metric server configuration.
ClusterNextidRequest nextid - Get next free VMID.
ClusterOptionsSetRequest options - Set datacenter options.
ClusterReplicationCreateRequest replication - Create a new replication job Create a new replication job https://pve.proxmox.com/pve-docs/api-viewer/index.html#/cluster/replication
.
ClusterReplicationDeleteRequest {id} - Mark replication job for removal.
ClusterReplicationReadRequest {id} - Read replication job configuration.
ClusterReplicationUpdateRequest {id} - Update replication job configuration.
ClusterResourcesRequest resources - Resources index (cluster wide).
ClusterResourcesResponse resources Resources index (cluster wide).
ClusterSdnControllersCreateRequest controllers - Create a new sdn controller object.
ClusterSdnControllersDeleteRequest {controller} - Delete sdn controller object configuration.
ClusterSdnControllersReadRequest {controller} - Read sdn controller configuration.
ClusterSdnControllersUpdateRequest {controller} - Update sdn controller object configuration.
ClusterSdnDnsCreateRequest dns - Create a new sdn dns object.
ClusterSdnDnsDeleteRequest {dns} - Delete sdn dns object configuration.
ClusterSdnDnsReadRequest {dns} - Read sdn dns configuration.
ClusterSdnDnsUpdateRequest {dns} - Update sdn dns object configuration.
ClusterSdnIpamsCreateRequest ipams - Create a new sdn ipam object.
ClusterSdnIpamsDeleteRequest {ipam} - Delete sdn ipam object configuration.
ClusterSdnIpamsReadRequest {ipam} - Read sdn ipam configuration.
ClusterSdnIpamsUpdateRequest {ipam} - Update sdn ipam object configuration.
ClusterSdnVnetsCreateRequest vnets - Create a new sdn vnet object.
ClusterSdnVnetsDeleteRequest {vnet} - Delete sdn vnet object configuration.
ClusterSdnVnetsReadRequest {vnet} - Read sdn vnet configuration.
ClusterSdnVnetsSubnetsCreateRequest subnets - Create a new sdn subnet object.
ClusterSdnVnetsSubnetsDeleteRequest {subnet} - Delete sdn subnet object configuration.
ClusterSdnVnetsSubnetsReadRequest {subnet} - Read sdn subnet configuration.
ClusterSdnVnetsSubnetsUpdateRequest {subnet} - Update sdn subnet object configuration.
ClusterSdnVnetsUpdateRequest {vnet} - Update sdn vnet object configuration.
ClusterSdnZonesCreateRequest zones - Create a new sdn zone object.
ClusterSdnZonesDeleteRequest {zone} - Delete sdn zone object configuration.
ClusterSdnZonesReadRequest {zone} - Read sdn zone configuration.
ClusterSdnZonesUpdateRequest {zone} - Update sdn zone object configuration.
ClusterStatusGetResponse status Get cluster status information.
ClusterTasksResponse tasks List recent tasks (cluster wide).
No description provided by the author
NodesAplinfoAplDownloadRequest aplinfo - Download appliance templates.
NodesAplinfoRequest aplinfo - Get list of appliances.
NodesAptChangelogRequest changelog - Get package changelogs.
NodesAptRepositoriesAddRepositoryRequest repositories - Add a standard repository to the configuration Add a standard repository to the configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/apt/repositories
.
NodesAptRepositoriesChangeRepositoryRequest repositories - Change the properties of a repository.
NodesAptRepositoriesRequest repositories - Get APT repository information.
NodesAptRepositoriesResponse repositories Get APT repository information.
NodesAptUpdateDatabaseRequest update - This is used to resynchronize the package index files from their sources (apt-get update).
NodesAptUpdateListsRequest update - List available updates.
NodesAptVersionsRequest versions - Get package information for important Proxmox packages.
NodesCapabilitiesQemuCapsIndexRequest qemu - QEMU capabilities index.
NodesCapabilitiesQemuMachinesTypesRequest machines - Get available QEMU/KVM machine types.
NodesCapabilitiesQemuMachinesTypesResponse machines Get available QEMU/KVM machine types.
NodesCephConfigdbRequest configdb - Get Ceph configuration database.
NodesCephConfigdbResponse configdb Get Ceph configuration database.
NodesCephConfigRequest config - Get Ceph configuration.
NodesCephCrushRequest crush - Get OSD crush map Get OSD crush map https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/crush
.
NodesCephFsCreatefsRequest {name} - Create a Ceph filesystem Create a Ceph filesystem https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/fs/{name}
.
NodesCephInitRequest init - Create initial ceph default configuration and setup symlinks.
NodesCephLogRequest log - Read ceph log Read ceph log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/log
.
NodesCephLogResponse log Read ceph log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/log
.
NodesCephMdsCreatemdsRequest {name} - Create Ceph Metadata Server (MDS) Create Ceph Metadata Server (MDS) https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/mds/{name}
.
NodesCephMdsDestroymdsRequest {name} - Destroy Ceph Metadata Server Destroy Ceph Metadata Server https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/mds/{name}
.
NodesCephMgrCreatemgrRequest {id} - Create Ceph Manager Create Ceph Manager https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/mgr/{id}
.
NodesCephMgrDestroymgrRequest {id} - Destroy Ceph Manager.
NodesCephMonCreatemonRequest {monid} - Create Ceph Monitor and Manager Create Ceph Monitor and Manager https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/mon/{monid}
.
NodesCephMonDestroymonRequest {monid} - Destroy Ceph Monitor and Manager.
NodesCephMonListmonRequest mon - Get Ceph monitor list.
NodesCephMonListmonResponse mon Get Ceph monitor list.
NodesCephOsdCreateosdRequest osd - Create OSD Create OSD https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/osd
.
NodesCephOsdDestroyosdRequest {osdid} - Destroy OSD Destroy OSD https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/osd/{osdid}
.
NodesCephOsdInRequest in - ceph osd in ceph osd in https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/osd/{osdid}/in
.
NodesCephOsdOutRequest out - ceph osd out ceph osd out https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/osd/{osdid}/out
.
NodesCephOsdScrubRequest scrub - Instruct the OSD to scrub.
NodesCephPoolsCreatepoolRequest pools - Create Ceph pool Create Ceph pool https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/pools
.
NodesCephPoolsDestroypoolRequest {name} - Destroy pool Destroy pool https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/pools/{name}
.
NodesCephPoolsGetpoolRequest {name} - List pool settings.
NodesCephPoolsGetpoolResponse {name} List pool settings.
NodesCephPoolsLspoolsRequest pools - List all pools.
NodesCephPoolsLspoolsResponse pools List all pools.
NodesCephPoolsSetpoolRequest {name} - Change POOL settings Change POOL settings https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/ceph/pools/{name}
.
NodesCephRestartRequest restart - Restart ceph services.
NodesCephRulesRequest rules - List ceph rules.
NodesCephStartRequest start - Start ceph services.
NodesCephStatusRequest status - Get ceph status.
NodesCephStopRequest stop - Stop ceph services.
NodesCertificatesAcmeCertificateNewRequest certificate - Order a new certificate from ACME-compatible CA.
NodesCertificatesAcmeCertificateRenewRequest certificate - Renew existing certificate from CA.
NodesCertificatesAcmeCertificateRevokeRequest certificate - Revoke existing certificate from CA.
NodesCertificatesCustomRemoveCertRequest custom - DELETE custom certificate chain and key.
NodesCertificatesCustomUploadCertRequest custom - Upload or update custom certificate chain and key.
NodesCertificatesCustomUploadCertResponse custom Upload or update custom certificate chain and key.
NodesCertificatesInfoRequest info - Get information about node's certificates.
NodesCertificatesInfoResponse info Get information about node's certificates.
NodesConfigGetRequest config - Get node configuration options.
NodesConfigGetResponse config Get node configuration options.
NodesConfigSetOptionsRequest config - Set node configuration options.
NodesDisksDirectoryCreateRequest directory - Create a Filesystem on an unused disk.
NodesDisksDirectoryDeleteRequest {name} - Unmounts the storage and removes the mount unit.
NodesDisksInitgptRequest initgpt - Initialize Disk with GPT Initialize Disk with GPT https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/disks/initgpt
.
NodesDisksListRequest list - List local disks.
NodesDisksListResponse list List local disks.
NodesDisksLvmCreateRequest lvm - Create an LVM Volume Group Create an LVM Volume Group https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/disks/lvm
.
NodesDisksLvmDeleteRequest {name} - Remove an LVM Volume Group.
NodesDisksLvmthinCreateRequest lvmthin - Create an LVM thinpool Create an LVM thinpool https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/disks/lvmthin
.
NodesDisksLvmthinDeleteRequest {name} - Remove an LVM thin pool.
NodesDisksSmartRequest smart - Get SMART Health of a disk.
NodesDisksSmartResponse smart Get SMART Health of a disk.
NodesDisksWipediskWipeDiskRequest wipedisk - Wipe a disk or partition.
NodesDisksZfsCreateRequest zfs - Create a ZFS pool.
NodesDisksZfsDeleteRequest {name} - Destroy a ZFS pool.
NodesDisksZfsDetailRequest {name} - Get details about a zpool.
NodesDisksZfsDetailResponse {name} Get details about a zpool.
NodesDnsRequest dns - Read DNS settings.
NodesDnsResponse dns Read DNS settings.
NodesDnsUpdateRequest dns - Write DNS settings.
NodesExecuteRequest execute - Execute multiple commands in order.
NodesFirewallLogRequest log - Read firewall log Read firewall log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/firewall/log
.
NodesFirewallLogResponse log Read firewall log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/firewall/log
.
NodesFirewallOptionsGetRequest options - Get host firewall options.
NodesFirewallOptionsGetResponse options Get host firewall options.
NodesFirewallOptionsSetRequest options - Set Firewall options.
NodesFirewallRulesCreateRuleRequest rules - Create new rule.
NodesFirewallRulesDeleteRuleRequest {pos} - Delete rule.
NodesFirewallRulesGetRequest rules - List rules.
NodesFirewallRulesGetResponse rules List rules.
NodesFirewallRulesGetRuleRequest {pos} - Get single rule data.
NodesFirewallRulesGetRuleResponse {pos} Get single rule data.
NodesFirewallRulesUpdateRuleRequest {pos} - Modify rule data.
NodesHardwarePciIndexRequest {pciid} - Index of available pci methods Index of available pci methods https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/hardware/pci/{pciid}
.
NodesHardwarePciIndexResponse {pciid} Index of available pci methods https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/hardware/pci/{pciid}
.
NodesHardwarePciMdevScanRequest mdev - List mediated device types for given PCI device.
NodesHardwarePciMdevScanResponse mdev List mediated device types for given PCI device.
NodesHardwarePciScanRequest pci - List local PCI devices.
NodesHardwarePciScanResponse pci List local PCI devices.
NodesHardwareUsbScanRequest usb - List local USB devices.
NodesHardwareUsbScanResponse usb List local USB devices.
NodesHostsGetEtcRequest hosts - Get the content of /etc/hosts.
NodesHostsGetEtcResponse hosts Get the content of /etc/hosts.
NodesHostsWriteEtcRequest hosts - Write /etc/hosts.
NodesJournalRequest journal - Read Journal Read Journal https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/journal
.
NodesLxcCloneVmRequest clone - Create a container clone/copy Create a container clone/copy https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/clone
.
NodesLxcConfigUpdateVmRequest config - Set container options.
NodesLxcConfigVmRequest config - Get container configuration.
NodesLxcConfigVmResponse config Get container configuration.
NodesLxcCreateVmRequest lxc - Create or restore a container.
NodesLxcDestroyVmRequest {vmid} - Destroy the container (also delete all uses files).
NodesLxcFeatureVmRequest feature - Check if feature for virtual machine is available.
NodesLxcFeatureVmResponse feature Check if feature for virtual machine is available.
NodesLxcFirewallAliasesCreateAliasRequest aliases - Create IP or Network Alias.
NodesLxcFirewallAliasesGetRequest aliases - List aliases List aliases https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/aliases
.
NodesLxcFirewallAliasesGetResponse aliases List aliases https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/aliases
.
NodesLxcFirewallAliasesReadAliasRequest {name} - Read alias.
NodesLxcFirewallAliasesRemoveAliasRequest {name} - Remove IP or Network alias.
NodesLxcFirewallAliasesUpdateAliasRequest {name} - Update IP or Network alias.
NodesLxcFirewallIpsetCreateIpRequest {name} - Add IP or Network to IPSet.
NodesLxcFirewallIpsetCreateRequest ipset - Create new IPSet Create new IPSet https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/ipset
.
NodesLxcFirewallIpsetDeleteRequest {name} - Delete IPSet Delete IPSet https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}
.
NodesLxcFirewallIpsetGetRequest {name} - List IPSet content List IPSet content https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}
.
NodesLxcFirewallIpsetGetResponse {name} List IPSet content https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}
.
NodesLxcFirewallIpsetIndexRequest ipset - List IPSets List IPSets https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/ipset
.
NodesLxcFirewallIpsetIndexResponse ipset List IPSets https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/ipset
.
NodesLxcFirewallIpsetReadIpRequest {cidr} - Read IP or Network settings from IPSet.
NodesLxcFirewallIpsetRemoveIpRequest {cidr} - Remove IP or Network from IPSet.
NodesLxcFirewallIpsetUpdateIpRequest {cidr} - Update IP or Network settings Update IP or Network settings https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr}
.
NodesLxcFirewallLogRequest log - Read firewall log Read firewall log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/log
.
NodesLxcFirewallLogResponse log Read firewall log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/firewall/log
.
NodesLxcFirewallOptionsGetRequest options - Get VM firewall options.
NodesLxcFirewallOptionsGetResponse options Get VM firewall options.
NodesLxcFirewallOptionsSetRequest options - Set Firewall options.
NodesLxcFirewallRefsRequest refs - Lists possible IPSet/Alias reference which are allowed in source/dest properties.
NodesLxcFirewallRefsResponse refs Lists possible IPSet/Alias reference which are allowed in source/dest properties.
NodesLxcFirewallRulesCreateRuleRequest rules - Create new rule.
NodesLxcFirewallRulesDeleteRuleRequest {pos} - Delete rule.
NodesLxcFirewallRulesGetRequest rules - List rules.
NodesLxcFirewallRulesGetResponse rules List rules.
NodesLxcFirewallRulesGetRuleRequest {pos} - Get single rule data.
NodesLxcFirewallRulesGetRuleResponse {pos} Get single rule data.
NodesLxcFirewallRulesUpdateRuleRequest {pos} - Modify rule data.
NodesLxcMigrateVmRequest migrate - Migrate the container to another node.
NodesLxcMoveVolumeRequest move_volume - Move a rootfs-/mp-volume to a different storage or to a different container.
NodesLxcPendingVmRequest pending - Get container configuration, including pending changes.
NodesLxcPendingVmResponse pending Get container configuration, including pending changes.
NodesLxcResizeVmRequest resize - Resize a container mount point.
NodesLxcRrddataRequest rrddata - Read VM RRD statistics Read VM RRD statistics https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/rrddata
.
NodesLxcRrdRequest rrd - Read VM RRD statistics (returns PNG) Read VM RRD statistics (returns PNG) https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/rrd
.
NodesLxcRrdResponse rrd Read VM RRD statistics (returns PNG) https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/rrd
.
NodesLxcSnapshotCmdIdxRequest {snapname} -
https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/snapshot/{snapname}
.
NodesLxcSnapshotConfigGetSnapshotRequest config - Get snapshot configuration Get snapshot configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config
.
NodesLxcSnapshotConfigUpdateSnapshotRequest config - Update snapshot metadata.
NodesLxcSnapshotDelsnapshotRequest {snapname} - Delete a LXC snapshot.
NodesLxcSnapshotListRequest snapshot - List all snapshots.
NodesLxcSnapshotListResponse snapshot List all snapshots.
NodesLxcSnapshotRequest snapshot - Snapshot a container.
NodesLxcSnapshotRollbackRequest rollback - Rollback LXC state to specified snapshot.
NodesLxcSpiceproxyRequest spiceproxy - Returns a SPICE configuration to connect to the CT.
NodesLxcSpiceproxyResponse spiceproxy Returns a SPICE configuration to connect to the CT.
NodesLxcStatusCurrentVmStatusRequest current - Get virtual machine status.
NodesLxcStatusCurrentVmStatusResponse current Get virtual machine status.
NodesLxcStatusRebootVmRequest reboot - Reboot the container by shutting it down, and starting it again.
NodesLxcStatusResumeVmRequest resume - Resume the container.
NodesLxcStatusShutdownVmRequest shutdown - Shutdown the container.
NodesLxcStatusStartVmRequest start - Start the container.
NodesLxcStatusStopVmRequest stop - Stop the container.
NodesLxcStatusSuspendVmRequest suspend - Suspend the container.
NodesLxcStatusVmcmdidxRequest status - Directory index Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/status
.
NodesLxcStatusVmcmdidxResponse status Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}/status
.
NodesLxcTemplateRequest template - Create a Template.
NodesLxcTermproxyRequest termproxy - Creates a TCP proxy connection.
NodesLxcTermproxyResponse termproxy Creates a TCP proxy connection.
NodesLxcVmdiridxRequest {vmid} - Directory index Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}
.
NodesLxcVmdiridxResponse {vmid} Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/lxc/{vmid}
.
NodesLxcVmlistRequest lxc - LXC container index (per node).
NodesLxcVmlistResponse lxc LXC container index (per node).
NodesLxcVncproxyRequest vncproxy - Creates a TCP VNC proxy connections.
NodesLxcVncproxyResponse vncproxy Creates a TCP VNC proxy connections.
NodesLxcVncwebsocketRequest vncwebsocket - Opens a weksocket for VNC traffic.
NodesLxcVncwebsocketResponse vncwebsocket Opens a weksocket for VNC traffic.
NodesMigrateallRequest migrateall - Migrate all VMs and Containers.
NodesNetstatRequest netstat - Read tap/vm network device interface counters Read tap/vm network device interface counters https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/netstat
.
NodesNetworkConfigRequest {iface} - Read network device configuration Read network device configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/network/{iface}
.
NodesNetworkConfigResponse {iface} Read network device configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/network/{iface}
.
NodesNetworkCreateRequest network - Create network device configuration Create network device configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/network
.
NodesNetworkDeleteRequest {iface} - Delete network device configuration Delete network device configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/network/{iface}
.
NodesNetworkReloadConfigRequest network - Reload network configuration Reload network configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/network
.
NodesNetworkRevertChangesRequest network - Revert network configuration changes.
NodesNetworkUpdateRequest {iface} - Update network device configuration Update network device configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/network/{iface}
.
NodesQemuAgentExecRequest exec - Executes the given command in the vm via the guest-agent and returns an object with the pid.
NodesQemuAgentExecResponse exec Executes the given command in the vm via the guest-agent and returns an object with the pid.
NodesQemuAgentExecStatusRequest exec-status - Gets the status of the given pid started by the guest-agent Gets the status of the given pid started by the guest-agent https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/agent/exec-status
.
NodesQemuAgentExecStatusResponse exec-status Gets the status of the given pid started by the guest-agent https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/agent/exec-status
.
NodesQemuAgentFileReadRequest file-read - Reads the given file via guest agent.
NodesQemuAgentFileReadResponse file-read Reads the given file via guest agent.
NodesQemuAgentFileWriteRequest file-write - Writes the given file via guest agent.
NodesQemuAgentFsfreezeFreezeRequest fsfreeze-freeze - Execute fsfreeze-freeze.
NodesQemuAgentFsfreezeStatusRequest fsfreeze-status - Execute fsfreeze-status.
NodesQemuAgentFsfreezeThawRequest fsfreeze-thaw - Execute fsfreeze-thaw.
NodesQemuAgentFstrimRequest fstrim - Execute fstrim.
NodesQemuAgentGetFsinfoRequest get-fsinfo - Execute get-fsinfo.
NodesQemuAgentGetHostNameRequest get-host-name - Execute get-host-name.
NodesQemuAgentGetMemoryBlockInfoRequest get-memory-block-info - Execute get-memory-block-info.
NodesQemuAgentGetMemoryBlocksRequest get-memory-blocks - Execute get-memory-blocks.
NodesQemuAgentGetOsinfoRequest get-osinfo - Execute get-osinfo.
NodesQemuAgentGetTimeRequest get-time - Execute get-time.
NodesQemuAgentGetTimezoneRequest get-timezone - Execute get-timezone.
NodesQemuAgentGetUsersRequest get-users - Execute get-users.
NodesQemuAgentGetVcpusRequest get-vcpus - Execute get-vcpus.
NodesQemuAgentInfoRequest info - Execute info.
NodesQemuAgentNetworkGetInterfacesRequest network-get-interfaces - Execute network-get-interfaces.
NodesQemuAgentPingRequest ping - Execute ping.
NodesQemuAgentRequest agent - Execute Qemu Guest Agent commands.
NodesQemuAgentSetUserPasswordRequest set-user-password - Sets the password for the given user to the given password Sets the password for the given user to the given password https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/agent/set-user-password
.
NodesQemuAgentShutdownRequest shutdown - Execute shutdown.
NodesQemuAgentSuspendDiskRequest suspend-disk - Execute suspend-disk.
NodesQemuAgentSuspendHybridRequest suspend-hybrid - Execute suspend-hybrid.
NodesQemuAgentSuspendRamRequest suspend-ram - Execute suspend-ram.
NodesQemuCloneVmRequest clone - Create a copy of virtual machine/template.
NodesQemuCloudinitDumpCloudinitGeneratedConfigRequest dump - Get automatically generated cloudinit config.
NodesQemuConfigUpdateVmAsyncRequest config - Set virtual machine options (asynchrounous API).
NodesQemuConfigUpdateVmRequest config - Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.
NodesQemuConfigVmRequest config - Get the virtual machine configuration with pending configuration changes applied.
NodesQemuConfigVmResponse config Get the virtual machine configuration with pending configuration changes applied.
NodesQemuCreateVmRequest qemu - Create or restore a virtual machine.
NodesQemuDestroyVmRequest {vmid} - Destroy the VM and all used/owned volumes.
NodesQemuFeatureVmRequest feature - Check if feature for virtual machine is available.
NodesQemuFeatureVmResponse feature Check if feature for virtual machine is available.
NodesQemuFirewallAliasesCreateAliasRequest aliases - Create IP or Network Alias.
NodesQemuFirewallAliasesGetRequest aliases - List aliases List aliases https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/aliases
.
NodesQemuFirewallAliasesGetResponse aliases List aliases https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/aliases
.
NodesQemuFirewallAliasesReadAliasRequest {name} - Read alias.
NodesQemuFirewallAliasesRemoveAliasRequest {name} - Remove IP or Network alias.
NodesQemuFirewallAliasesUpdateAliasRequest {name} - Update IP or Network alias.
NodesQemuFirewallIpsetCreateIpRequest {name} - Add IP or Network to IPSet.
NodesQemuFirewallIpsetCreateRequest ipset - Create new IPSet Create new IPSet https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/ipset
.
NodesQemuFirewallIpsetDeleteRequest {name} - Delete IPSet Delete IPSet https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}
.
NodesQemuFirewallIpsetGetRequest {name} - List IPSet content List IPSet content https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}
.
NodesQemuFirewallIpsetGetResponse {name} List IPSet content https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}
.
NodesQemuFirewallIpsetIndexRequest ipset - List IPSets List IPSets https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/ipset
.
NodesQemuFirewallIpsetIndexResponse ipset List IPSets https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/ipset
.
NodesQemuFirewallIpsetReadIpRequest {cidr} - Read IP or Network settings from IPSet.
NodesQemuFirewallIpsetRemoveIpRequest {cidr} - Remove IP or Network from IPSet.
NodesQemuFirewallIpsetUpdateIpRequest {cidr} - Update IP or Network settings Update IP or Network settings https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr}
.
NodesQemuFirewallLogRequest log - Read firewall log Read firewall log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/log
.
NodesQemuFirewallLogResponse log Read firewall log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/firewall/log
.
NodesQemuFirewallOptionsGetRequest options - Get VM firewall options.
NodesQemuFirewallOptionsGetResponse options Get VM firewall options.
NodesQemuFirewallOptionsSetRequest options - Set Firewall options.
NodesQemuFirewallRefsRequest refs - Lists possible IPSet/Alias reference which are allowed in source/dest properties.
NodesQemuFirewallRefsResponse refs Lists possible IPSet/Alias reference which are allowed in source/dest properties.
NodesQemuFirewallRulesCreateRuleRequest rules - Create new rule.
NodesQemuFirewallRulesDeleteRuleRequest {pos} - Delete rule.
NodesQemuFirewallRulesGetRequest rules - List rules.
NodesQemuFirewallRulesGetResponse rules List rules.
NodesQemuFirewallRulesGetRuleRequest {pos} - Get single rule data.
NodesQemuFirewallRulesGetRuleResponse {pos} Get single rule data.
NodesQemuFirewallRulesUpdateRuleRequest {pos} - Modify rule data.
NodesQemuMigrateVmPreconditionRequest migrate - Get preconditions for migration.
NodesQemuMigrateVmPreconditionResponse migrate Get preconditions for migration.
NodesQemuMigrateVmRequest migrate - Migrate virtual machine.
NodesQemuMonitorRequest monitor - Execute Qemu monitor commands.
NodesQemuMoveDiskMoveVmDiskRequest move_disk - Move volume to different storage or to a different VM.
NodesQemuPendingVmRequest pending - Get the virtual machine configuration with both current and pending values.
NodesQemuPendingVmResponse pending Get the virtual machine configuration with both current and pending values.
NodesQemuResizeVmRequest resize - Extend volume size.
NodesQemuRrddataRequest rrddata - Read VM RRD statistics Read VM RRD statistics https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/rrddata
.
NodesQemuRrdRequest rrd - Read VM RRD statistics (returns PNG) Read VM RRD statistics (returns PNG) https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/rrd
.
NodesQemuRrdResponse rrd Read VM RRD statistics (returns PNG) https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/rrd
.
NodesQemuSendkeyVmRequest sendkey - Send key event to virtual machine.
NodesQemuSnapshotCmdIdxRequest {snapname} -
https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/snapshot/{snapname}
.
NodesQemuSnapshotConfigGetSnapshotRequest config - Get snapshot configuration Get snapshot configuration https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config
.
NodesQemuSnapshotConfigUpdateSnapshotRequest config - Update snapshot metadata.
NodesQemuSnapshotDelsnapshotRequest {snapname} - Delete a VM snapshot.
NodesQemuSnapshotListRequest snapshot - List all snapshots.
NodesQemuSnapshotListResponse snapshot List all snapshots.
NodesQemuSnapshotRequest snapshot - Snapshot a VM.
NodesQemuSnapshotRollbackRequest rollback - Rollback VM state to specified snapshot.
NodesQemuSpiceproxyRequest spiceproxy - Returns a SPICE configuration to connect to the VM.
NodesQemuSpiceproxyResponse spiceproxy Returns a SPICE configuration to connect to the VM.
NodesQemuStatusCurrentVmStatusRequest current - Get virtual machine status.
NodesQemuStatusCurrentVmStatusResponse current Get virtual machine status.
NodesQemuStatusRebootVmRequest reboot - Reboot the VM by shutting it down, and starting it again.
NodesQemuStatusResetVmRequest reset - Reset virtual machine.
NodesQemuStatusResumeVmRequest resume - Resume virtual machine.
NodesQemuStatusShutdownVmRequest shutdown - Shutdown virtual machine.
NodesQemuStatusStartVmRequest start - Start virtual machine.
NodesQemuStatusStopVmRequest stop - Stop virtual machine.
NodesQemuStatusSuspendVmRequest suspend - Suspend virtual machine.
NodesQemuStatusVmcmdidxRequest status - Directory index Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/status
.
NodesQemuStatusVmcmdidxResponse status Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}/status
.
NodesQemuTemplateRequest template - Create a Template.
NodesQemuTermproxyRequest termproxy - Creates a TCP proxy connections.
NodesQemuTermproxyResponse termproxy Creates a TCP proxy connections.
NodesQemuUnlinkRequest unlink - Unlink/delete disk images.
NodesQemuVmdiridxRequest {vmid} - Directory index Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}
.
NodesQemuVmdiridxResponse {vmid} Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/qemu/{vmid}
.
NodesQemuVmlistRequest qemu - Virtual machine index (per node).
NodesQemuVmlistResponse qemu Virtual machine index (per node).
NodesQemuVncproxyRequest vncproxy - Creates a TCP VNC proxy connections.
NodesQemuVncproxyResponse vncproxy Creates a TCP VNC proxy connections.
NodesQemuVncwebsocketRequest vncwebsocket - Opens a weksocket for VNC traffic.
NodesQemuVncwebsocketResponse vncwebsocket Opens a weksocket for VNC traffic.
NodesQueryUrlMetadataQueryUrlMetadataRequest query-url-metadata - Query metadata of an URL: file size, file name and mime type.
NodesQueryUrlMetadataQueryUrlMetadataResponse query-url-metadata Query metadata of an URL: file size, file name and mime type.
NodesReplicationLogReadJobRequest log - Read replication job log.
NodesReplicationLogReadJobResponse log Read replication job log.
NodesReplicationScheduleNowRequest schedule_now - Schedule replication job to start as soon as possible.
NodesReplicationStatusJobRequest status - Get replication job status.
NodesReplicationStatusRequest replication - List status of all replication jobs on this node.
NodesReplicationStatusResponse replication List status of all replication jobs on this node.
NodesReportRequest report - Gather various systems information about a node Gather various systems information about a node https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/report
.
NodesRrddataRequest rrddata - Read node RRD statistics Read node RRD statistics https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/rrddata
.
NodesRrdRequest rrd - Read node RRD statistics (returns PNG) Read node RRD statistics (returns PNG) https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/rrd
.
NodesRrdResponse rrd Read node RRD statistics (returns PNG) https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/rrd
.
NodesScanCifsScanRequest cifs - Scan remote CIFS server.
NodesScanCifsScanResponse cifs Scan remote CIFS server.
NodesScanGlusterfsScanRequest glusterfs - Scan remote GlusterFS server.
NodesScanGlusterfsScanResponse glusterfs Scan remote GlusterFS server.
NodesScanIscsiScanRequest iscsi - Scan remote iSCSI server.
NodesScanIscsiScanResponse iscsi Scan remote iSCSI server.
NodesScanLvmScanRequest lvm - List local LVM volume groups.
NodesScanLvmScanResponse lvm List local LVM volume groups.
NodesScanLvmthinScanRequest lvmthin - List local LVM Thin Pools.
NodesScanLvmthinScanResponse lvmthin List local LVM Thin Pools.
NodesScanNfsScanRequest nfs - Scan remote NFS server.
NodesScanNfsScanResponse nfs Scan remote NFS server.
NodesScanPbsScanRequest pbs - Scan remote Proxmox Backup Server.
NodesScanPbsScanResponse pbs Scan remote Proxmox Backup Server.
NodesScanZfsScanRequest zfs - Scan zfs pool list on local node.
NodesScanZfsScanResponse zfs Scan zfs pool list on local node.
NodesSdnIndexRequest sdn - SDN index.
NodesSdnZonesDiridxRequest {zone} -
https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/sdn/zones/{zone}
.
NodesSdnZonesDiridxResponse {zone}
https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/sdn/zones/{zone}
.
NodesServicesReloadServiceRequest reload - Reload service.
NodesServicesRestartServiceRequest restart - Hard restart service.
NodesServicesSrvcmdidxRequest {service} - Directory index Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/services/{service}
.
NodesServicesSrvcmdidxResponse {service} Directory index https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/services/{service}
.
NodesServicesStartServiceRequest start - Start service.
NodesServicesStateServiceRequest state - Read service properties Read service properties https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/services/{service}/state
.
NodesServicesStopServiceRequest stop - Stop service.
NodesSpiceshellRequest spiceshell - Creates a SPICE shell.
NodesSpiceshellResponse spiceshell Creates a SPICE shell.
NodesStartallRequest startall - Start all VMs and containers located on this node (by default only those with onboot=1).
NodesStatusNodeCmdRequest status - Reboot or shutdown a node.
NodesStatusRequest status - Read node status Read node status https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/status
.
NodesStopallRequest stopall - Stop all VMs and Containers.
NodesStorageContentCopyRequest {volume} - Copy a volume.
NodesStorageContentCreateRequest content - Allocate disk images.
NodesStorageContentDeleteRequest {volume} - Delete volume Delete volume https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/storage/{storage}/content/{volume}
.
NodesStorageContentInfoRequest {volume} - Get volume attributes Get volume attributes https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/storage/{storage}/content/{volume}
.
NodesStorageContentInfoResponse {volume} Get volume attributes https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/storage/{storage}/content/{volume}
.
NodesStorageContentUpdateattributesRequest {volume} - Update volume attributes Update volume attributes https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/storage/{storage}/content/{volume}
.
NodesStorageDiridxRequest {storage} -
https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/storage/{storage}
.
NodesStorageDiridxResponse {storage}
https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/storage/{storage}
.
NodesStorageDownloadUrlDownloadUrlRequest download-url - Download templates and ISO images by using an URL.
NodesStorageFileRestoreDownloadRequest download - Extract a file or directory (as zip archive) from a PBS backup.
NodesStorageFileRestoreListRequest list - List files and directories for single file restore under the given path.
NodesStorageFileRestoreListResponse list List files and directories for single file restore under the given path.
NodesStoragePrunebackupsDeleteRequest prunebackups - Prune backups.
NodesStoragePrunebackupsDryrunRequest prunebackups - Get prune information for backups.
NodesStoragePrunebackupsDryrunResponse prunebackups Get prune information for backups.
NodesStorageRrddataRequest rrddata - Read storage RRD statistics.
NodesStorageRrdRequest rrd - Read storage RRD statistics (returns PNG).
NodesStorageRrdResponse rrd Read storage RRD statistics (returns PNG).
NodesStorageStatusReadRequest status - Read storage status.
NodesStorageUploadRequest upload - Upload templates and ISO images.
NodesSubscriptionDeleteRequest subscription - Delete subscription key of this node.
NodesSubscriptionGetRequest subscription - Read subscription info.
NodesSubscriptionSetRequest subscription - Set subscription key.
NodesSubscriptionUpdateRequest subscription - Update subscription info.
NodesSyslogRequest syslog - Read system log Read system log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/syslog
.
NodesSyslogResponse syslog Read system log https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/syslog
.
NodesTasksLogReadTaskRequest log - Read task log.
NodesTasksLogReadTaskResponse log Read task log.
NodesTasksNodeRequest tasks - Read task list for one node (finished tasks).
NodesTasksNodeResponse tasks Read task list for one node (finished tasks).
NodesTasksStatusReadTaskRequest status - Read task status.
NodesTasksStatusReadTaskResponse status Read task status.
NodesTasksStopTaskRequest {upid} - Stop a task.
NodesTasksUpidIndexRequest {upid} -
https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/tasks/{upid}
.
NodesTermproxyRequest termproxy - Creates a VNC Shell proxy.
NodesTermproxyResponse termproxy Creates a VNC Shell proxy.
NodesTimeRequest time - Read server time and time zone settings.
NodesTimeResponse time Read server time and time zone settings.
NodesTimeSetzoneRequest time - Set time zone.
NodesVersionRequest version - API version details API version details https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/version
.
NodesVersionResponse version API version details https://pve.proxmox.com/pve-docs/api-viewer/index.html#/nodes/{node}/version
.
NodesVncshellRequest vncshell - Creates a VNC Shell proxy.
NodesVncshellResponse vncshell Creates a VNC Shell proxy.
NodesVncwebsocketRequest vncwebsocket - Opens a websocket for VNC traffic.
NodesVncwebsocketResponse vncwebsocket Opens a websocket for VNC traffic.
NodesVzdumpDefaultsRequest defaults - Get the currently configured vzdump defaults.
NodesVzdumpDefaultsResponse defaults Get the currently configured vzdump defaults.
NodesVzdumpExtractconfigRequest extractconfig - Extract configuration from vzdump backup archive.
NodesVzdumpRequest vzdump - Create backup.
NodesWakeonlanRequest wakeonlan - Try to wake a node via 'wake on LAN' network packet.
PoolsCreateRequest pools - Create new pool.
PoolsDeleteRequest {poolid} - Delete pool.
PoolsReadRequest {poolid} - Get pool configuration.
PoolsReadResponse {poolid} Get pool configuration.
PoolsUpdateRequest {poolid} - Update pool data.
StorageCreateRequest storage - Create a new storage.
StorageCreateResponse storage Create a new storage.
StorageDeleteRequest {storage} - Delete storage configuration.
StorageReadRequest {storage} - Read storage configuration.
StorageUpdateRequest {storage} - Update storage configuration.
StorageUpdateResponse {storage} Update storage configuration.
No description provided by the author
VersionResponse version API version details, including some parts of the global datacenter config.