API Changes Introduced in 4.15.0.0

For the complete list of API commands and params consult the CloudStack Apidocs.

New API Commands

Name Description
listVsphereStoragePolicyCompatiblePools List storage pools compatible with a vSphere storage policy
listProjectRolePermissions Lists a project’s project role permissions
importVsphereStoragePolicies Import vSphere storage policies
migrateSecondaryStorageData migrates data objects from one secondary storage to destination image store(s)
unmanageVirtualMachine Unmanage a guest virtual machine.
updateImageStore Updates image store read-only status
deleteProjectRole Delete Project roles in CloudStack
deleteUserFromProject Deletes user from the project
listProjectRoles Lists Project roles in CloudStack
createProjectRole Creates a Project role
updateProjectRole Creates a Project role
listVsphereStoragePolicies List vSphere storage policies
createProjectRolePermission Adds API permissions to a project role
updateProjectRolePermission Updates a project role permission and/or order
addUserToProject Adds user to a project
importRole Imports a role based on provided map of rule permissions
deleteProjectRolePermission Deletes a project role permission in the project

Removed API Commands

Name Description
listTemplateOvfProperties List template OVF properties if available.

Parameters Changed API Commands

Name Description
copyIso

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
listVirtualMachinesMetrics

Request:

New Parameters:

  • haenable (optional)
  • securitygroupid (optional)
listHosts

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
updateStoragePool

Request:

New Parameters:

  • name (optional)
rebootSystemVm

Response:

New Parameters:

  • podname
  • templatename
listNetworks

Request:

New Parameters:

  • networkofferingid (optional)

Response:

New Parameters:

  • aclname
  • vpcname
restoreVirtualMachine

Response:

New Parameters:

  • osdisplayname
updateHost

Request:

New Parameters:

  • name (optional)

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
destroySystemVm

Response:

New Parameters:

  • podname
  • templatename
addSwift

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
scaleSystemVm

Response:

New Parameters:

  • podname
  • templatename
stopRouter

Response:

New Parameters:

  • podname
  • templatename
listProjectInvitations

Request:

New Parameters:

  • userid (optional)

Response:

New Parameters:

  • userid
listLdapConfigurations

Request:

New Parameters:

  • listall (optional)
listSecondaryStagingStores

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
startRouter

Response:

New Parameters:

  • podname
  • templatename
changeServiceForVirtualMachine

Response:

New Parameters:

  • osdisplayname
listTemplates

Request:

New Parameters:

  • details (optional)
  • showunique (optional)

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
listPhysicalNetworks

Response:

New Parameters:

  • zonename
createSecondaryStagingStore

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
rebootVirtualMachine

Request:

New Parameters:

  • bootintosetup (optional)

Response:

New Parameters:

  • osdisplayname
updateVPC

Response:

New Parameters:

  • vpcofferingname
stopSystemVm

Response:

New Parameters:

  • podname
  • templatename
listPrivateGateways

Response:

New Parameters:

  • aclname
  • vpcname
updateVmNicIp

Response:

New Parameters:

  • osdisplayname
startInternalLoadBalancerVM

Response:

New Parameters:

  • podname
  • templatename
updateDiskOffering

Request:

New Parameters:

  • bytesreadrate (optional)
  • bytesreadratemax (optional)
  • bytesreadratemaxlength (optional)
  • byteswriterate (optional)
  • byteswriteratemax (optional)
  • byteswriteratemaxlength (optional)
  • cachemode (optional)
  • iopsreadrate (optional)
  • iopsreadratemax (optional)
  • iopsreadratemaxlength (optional)
  • iopswriterate (optional)
  • iopswriteratemax (optional)
  • iopswriteratemaxlength (optional)
  • tags (optional)

Response:

New Parameters:

  • vspherestoragepolicy
addAccountToProject

Request:

New Parameters:

  • projectroleid (optional)
  • roletype (optional)
listKubernetesClusters

Response:

New Parameters:

  • ipaddress
  • ipaddressid
  • virtualmachines

Removed Parameters:

  • virtualmachineids
scaleKubernetesCluster

Request:

Changed Parameters:

  • id was ‘optional’ and is now ‘required’

Response:

New Parameters:

  • ipaddress
  • ipaddressid
  • virtualmachines

Removed Parameters:

  • virtualmachineids
stopNetScalerVpx

Response:

New Parameters:

  • podname
  • templatename
updatePhysicalNetwork

Response:

New Parameters:

  • zonename
createRolePermission

Response:

Removed Parameters:

  • description
  • permission
  • rule
listSystemVms

Response:

New Parameters:

  • podname
  • templatename
createProject

Request:

New Parameters:

  • accountid (optional)
  • userid (optional)

Response:

New Parameters:

  • owner
changeServiceForSystemVm

Response:

New Parameters:

  • podname
  • templatename
rebootRouter

Response:

New Parameters:

  • podname
  • templatename
findHostsForMigration

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
addNicToVirtualMachine

Response:

New Parameters:

  • osdisplayname
listStaticRoutes

Request:

New Parameters:

  • state (optional)
listPublicIpAddresses

Response:

New Parameters:

  • networkname
  • vpcname
updateIso

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
listExternalLoadBalancers

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
updateDefaultNicForVirtualMachine

Response:

New Parameters:

  • osdisplayname
prepareTemplate

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
stopInternalLoadBalancerVM

Response:

New Parameters:

  • podname
  • templatename
restartNetwork

Response:

New Parameters:

  • networkname
  • vpcname
addImageStore

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
listRolePermissions

Response:

Removed Parameters:

  • description
  • permission
  • rule
listNetworkACLs

Response:

New Parameters:

  • aclname
copyTemplate

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
createServiceOffering

Request:

New Parameters:

  • rootdisksize (optional)
  • storagepolicy (optional)

Response:

New Parameters:

  • rootdisksize
  • vspherestoragepolicy
listNiciraNvpDeviceNetworks

Response:

New Parameters:

  • aclname
  • vpcname
assignVirtualMachine

Response:

New Parameters:

  • osdisplayname
updateTemplate

Request:

New Parameters:

  • templatetype (optional)

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
listPaloAltoFirewallNetworks

Response:

New Parameters:

  • aclname
  • vpcname
changeServiceForRouter

Response:

New Parameters:

  • podname
  • templatename
updateVirtualMachine

Response:

New Parameters:

  • osdisplayname
addSecondaryStorage

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
updateNetwork

Response:

New Parameters:

  • aclname
  • vpcname
updateVpnGateway

Response:

New Parameters:

  • vpcname
migrateVirtualMachine

Response:

New Parameters:

  • osdisplayname
createTemplate

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
resetPasswordForVirtualMachine

Response:

New Parameters:

  • osdisplayname
associateIpAddress

Response:

New Parameters:

  • networkname
  • vpcname
createNetworkACL

Response:

New Parameters:

  • aclname
resetSSHKeyForVirtualMachine

Response:

New Parameters:

  • osdisplayname
createVPC

Response:

New Parameters:

  • vpcofferingname
listInternalLoadBalancerVMs

Response:

New Parameters:

  • podname
  • templatename
listSrxFirewallNetworks

Response:

New Parameters:

  • aclname
  • vpcname
detachIso

Response:

New Parameters:

  • osdisplayname
createRole

Request:

New Parameters:

  • roleid (optional)

Changed Parameters:

  • type was ‘required’ and is now ‘optional’

Response:

New Parameters:

  • isdefault

Removed Parameters:

  • id
  • description
  • name
prepareHostForMaintenance

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
listVirtualMachines

Request:

New Parameters:

  • haenable (optional)
  • securitygroupid (optional)

Response:

New Parameters:

  • osdisplayname
listDiskOfferings

Response:

New Parameters:

  • vspherestoragepolicy
upgradeKubernetesCluster

Response:

New Parameters:

  • ipaddress
  • ipaddressid
  • virtualmachines

Removed Parameters:

  • virtualmachineids
listProjects

Request:

New Parameters:

  • username (optional)

Response:

New Parameters:

  • owner
revertToVMSnapshot

Response:

New Parameters:

  • osdisplayname
registerIso

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
deployVirtualMachine

Request:

New Parameters:

  • bootintosetup (optional)
  • nicnetworklist (optional)
  • properties (optional)

Removed Parameters:

  • ovfproperties

Response:

New Parameters:

  • osdisplayname
cancelHostMaintenance

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
listProjectAccounts

Request:

New Parameters:

  • projectroleid (optional)
  • userid (optional)

Response:

New Parameters:

  • owner
createDiskOffering

Request:

New Parameters:

  • storagepolicy (optional)

Response:

New Parameters:

  • vspherestoragepolicy
createNetwork

Response:

New Parameters:

  • aclname
  • vpcname
listVPCs

Response:

New Parameters:

  • vpcofferingname
migrateVirtualMachineWithVolume

Response:

New Parameters:

  • osdisplayname
restartVPC

Response:

New Parameters:

  • vpcofferingname
addHost

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
updateProject

Request:

New Parameters:

  • roletype (optional)
  • swapowner (optional)
  • userid (optional)

Response:

New Parameters:

  • owner
listIsos

Request:

New Parameters:

  • showunique (optional)

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
updateCloudToUseObjectStore

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
updateRole

Response:

New Parameters:

  • isdefault

Removed Parameters:

  • id
  • description
  • name
listNetscalerLoadBalancerNetworks

Response:

New Parameters:

  • aclname
  • vpcname
startSystemVm

Response:

New Parameters:

  • podname
  • templatename
createKubernetesCluster

Response:

New Parameters:

  • ipaddress
  • ipaddressid
  • virtualmachines

Removed Parameters:

  • virtualmachineids
updateVMAffinityGroup

Response:

New Parameters:

  • osdisplayname
migrateVPC

Response:

New Parameters:

  • vpcofferingname
recoverVirtualMachine

Response:

New Parameters:

  • osdisplayname
getUploadParamsForTemplate

Request:

Changed Parameters:

  • ostypeid was ‘required’ and is now ‘optional’
updateProjectInvitation

Request:

New Parameters:

  • userid (optional)
migrateSystemVm

Response:

New Parameters:

  • podname
  • templatename
listVpnGateways

Response:

New Parameters:

  • vpcname
listRoles

Response:

New Parameters:

  • isdefault

Removed Parameters:

  • id
  • description
  • name
updateNetworkACLItem

Response:

New Parameters:

  • aclname
listRouters

Response:

New Parameters:

  • podname
  • templatename
listBrocadeVcsDeviceNetworks

Response:

New Parameters:

  • aclname
  • vpcname
listSwifts

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
listUsageRecords

Response:

New Parameters:

  • ostypeid
  • vpcid
suspendProject

Response:

New Parameters:

  • owner
updateIpAddress

Response:

New Parameters:

  • networkname
  • vpcname
migrateNetwork

Response:

New Parameters:

  • aclname
  • vpcname
registerTemplate

Request:

Changed Parameters:

  • ostypeid was ‘required’ and is now ‘optional’

Response:

New Parameters:

  • deployasis
  • deployasisdetails
  • downloaddetails
  • url
importUnmanagedInstance

Request:

New Parameters:

  • forced (optional)

Response:

New Parameters:

  • osdisplayname
addImageStoreS3

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
createPhysicalNetwork

Response:

New Parameters:

  • zonename
listF5LoadBalancerNetworks

Response:

New Parameters:

  • aclname
  • vpcname
listVMSnapshot

Response:

New Parameters:

  • hypervisor
moveNetworkAclItem

Response:

New Parameters:

  • aclname
attachIso

Response:

New Parameters:

  • osdisplayname
createVpnGateway

Response:

New Parameters:

  • vpcname
createVMSnapshot

Response:

New Parameters:

  • hypervisor
destroyRouter

Response:

New Parameters:

  • podname
  • templatename
listImageStores

Request:

New Parameters:

  • readonly (optional)

Response:

New Parameters:

  • disksizetotal
  • disksizeused
  • readonly
removeNicFromVirtualMachine

Response:

New Parameters:

  • osdisplayname
activateProject

Response:

New Parameters:

  • owner
reconnectHost

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
startKubernetesCluster

Response:

New Parameters:

  • ipaddress
  • ipaddressid
  • virtualmachines

Removed Parameters:

  • virtualmachineids
createPrivateGateway

Response:

New Parameters:

  • aclname
  • vpcname
uploadSslCert

Request:

New Parameters:

  • enabledrevocationcheck (optional)
addBaremetalHost

Response:

New Parameters:

  • cpuallocatedpercentage
  • cpuallocatedvalue
  • cpuallocatedwithoverprovisioning
  • memoryallocatedbytes
  • memoryallocatedpercentage
destroyVirtualMachine

Response:

New Parameters:

  • osdisplayname
listServiceOfferings

Request:

New Parameters:

  • cpunumber (optional)
  • cpuspeed (optional)
  • memory (optional)

Response:

New Parameters:

  • rootdisksize
  • vspherestoragepolicy
startVirtualMachine

Request:

New Parameters:

  • bootintosetup (optional)

Response:

New Parameters:

  • osdisplayname
updateServiceOffering

Response:

New Parameters:

  • rootdisksize
  • vspherestoragepolicy
stopVirtualMachine

Response:

New Parameters:

  • osdisplayname