Apache CloudStack API Documentation (4.16.0.0)
Using the CloudStack API
For information about how the APIs work, and tips on how to use them, see the Developer's Guide.
All APIs
Commands available through the developer API URL and the integration API URL.(A) implies that the command is asynchronous.
(*) implies element has a child.
Network
- addNetworkDevice
- addNetworkServiceProvider (A)
- addOpenDaylightController (A)
- createNetwork
- createNetworkACL (A)
- createNetworkACLList (A)
- createNetworkOffering
- createPhysicalNetwork (A)
- createServiceInstance (A)
- createStorageNetworkIpRange (A)
- dedicatePublicIpRange
- deleteNetwork (A)
- deleteNetworkACL (A)
- deleteNetworkACLList (A)
- deleteNetworkDevice
- deleteNetworkOffering
- deleteNetworkServiceProvider (A)
- deleteOpenDaylightController (A)
- deletePhysicalNetwork (A)
- deleteStorageNetworkIpRange (A)
- listBrocadeVcsDeviceNetworks
- listF5LoadBalancerNetworks
- listNetscalerLoadBalancerNetworks
- listNetworkACLLists
- listNetworkACLs
- listNetworkDevice
- listNetworkIsolationMethods
- listNetworkOfferings
- listNetworkServiceProviders
- listNetworks
- listNiciraNvpDeviceNetworks
- listOpenDaylightControllers
- listPaloAltoFirewallNetworks
- listPhysicalNetworks
- listSrxFirewallNetworks
- listStorageNetworkIpRange
- listSupportedNetworkServices
- migrateNetwork (A)
- moveNetworkAclItem (A)
- releasePublicIpRange
- replaceNetworkACLList (A)
- restartNetwork (A)
- updateNetwork (A)
- updateNetworkACLItem (A)
- updateNetworkACLList (A)
- updateNetworkOffering
- updateNetworkServiceProvider (A)
- updatePhysicalNetwork (A)
- updateStorageNetworkIpRange (A)
Load Balancer
- addF5LoadBalancer (A)
- addNetscalerLoadBalancer (A)
- assignCertToLoadBalancer (A)
- assignToGlobalLoadBalancerRule (A)
- assignToLoadBalancerRule (A)
- configureF5LoadBalancer (A)
- configureNetscalerLoadBalancer (A)
- createGlobalLoadBalancerRule (A)
- createLBHealthCheckPolicy (A)
- createLBStickinessPolicy (A)
- createLoadBalancer (A)
- createLoadBalancerRule (A)
- deleteF5LoadBalancer (A)
- deleteGlobalLoadBalancerRule (A)
- deleteLBHealthCheckPolicy (A)
- deleteLBStickinessPolicy (A)
- deleteLoadBalancer (A)
- deleteLoadBalancerRule (A)
- deleteNetscalerControlCenter
- deleteNetscalerLoadBalancer (A)
- deleteServicePackageOffering
- deleteSslCert
- deployNetscalerVpx (A)
- listF5LoadBalancers
- listGlobalLoadBalancerRules
- listLBHealthCheckPolicies
- listLBStickinessPolicies
- listLoadBalancerRuleInstances
- listLoadBalancerRules
- listLoadBalancers
- listNetscalerControlCenter
- listNetscalerLoadBalancers
- listRegisteredServicePackages
- listSslCerts
- removeCertFromLoadBalancer (A)
- removeFromGlobalLoadBalancerRule (A)
- removeFromLoadBalancerRule (A)
- stopNetScalerVpx (A)
- updateGlobalLoadBalancerRule (A)
- updateLBHealthCheckPolicy (A)
- updateLBStickinessPolicy (A)
- updateLoadBalancer (A)
- updateLoadBalancerRule (A)
- uploadSslCert
Virtual Machine
- addNicToVirtualMachine (A)
- assignVirtualMachine
- changeServiceForVirtualMachine
- cleanVMReservations (A)
- deployVirtualMachine (A)
- destroyVirtualMachine (A)
- expungeVirtualMachine (A)
- getVMPassword
- importUnmanagedInstance (A)
- listInternalLoadBalancerVMs
- listUnmanagedInstances
- listVirtualMachines
- listVirtualMachinesMetrics
- migrateVirtualMachine (A)
- migrateVirtualMachineWithVolume (A)
- rebootVirtualMachine (A)
- recoverVirtualMachine
- removeNicFromVirtualMachine (A)
- resetPasswordForVirtualMachine (A)
- resetSSHKeyForVirtualMachine (A)
- restoreVirtualMachine (A)
- scaleVirtualMachine (A)
- startInternalLoadBalancerVM (A)
- startVirtualMachine (A)
- stopInternalLoadBalancerVM (A)
- stopVirtualMachine (A)
- unmanageVirtualMachine (A)
- updateDefaultNicForVirtualMachine (A)
- updateVirtualMachine
Host
- addBaremetalHost
- addGloboDnsHost (A)
- addHost
- addSecondaryStorage
- cancelHostAsDegraded (A)
- cancelHostMaintenance (A)
- configureHAForHost (A)
- declareHostAsDegraded (A)
- dedicateHost (A)
- deleteHost
- disableHAForHost (A)
- enableHAForHost (A)
- findHostsForMigration
- listDedicatedHosts
- listHostHAProviders
- listHostHAResources
- listHostTags
- listHosts
- listHostsMetrics
- migrateSecondaryStorageData (A)
- prepareHostForMaintenance (A)
- reconnectHost (A)
- releaseDedicatedHost (A)
- releaseHostReservation (A)
- updateHost
- updateHostPassword
Firewall
- addPaloAltoFirewall (A)
- addSrxFirewall (A)
- configurePaloAltoFirewall (A)
- configureSrxFirewall (A)
- createEgressFirewallRule (A)
- createFirewallRule (A)
- createPortForwardingRule (A)
- deleteEgressFirewallRule (A)
- deleteFirewallRule (A)
- deletePaloAltoFirewall (A)
- deletePortForwardingRule (A)
- deleteSrxFirewall (A)
- listEgressFirewallRules
- listFirewallRules
- listPaloAltoFirewalls
- listPortForwardingRules
- listSrxFirewalls
- updateEgressFirewallRule (A)
- updateFirewallRule (A)
- updatePortForwardingRule (A)
AutoScale
- createAutoScalePolicy (A)
- createAutoScaleVmGroup (A)
- createAutoScaleVmProfile (A)
- createCondition (A)
- createCounter (A)
- deleteAutoScalePolicy (A)
- deleteAutoScaleVmGroup (A)
- deleteAutoScaleVmProfile (A)
- deleteCondition (A)
- deleteCounter (A)
- disableAutoScaleVmGroup (A)
- enableAutoScaleVmGroup (A)
- listAutoScalePolicies
- listAutoScaleVmGroups
- listAutoScaleVmProfiles
- listConditions
- listCounters
- updateAutoScalePolicy (A)
- updateAutoScaleVmGroup (A)
- updateAutoScaleVmProfile (A)
Volume
- attachVolume (A)
- createVolume (A)
- deleteVolume
- destroyVolume (A)
- detachVolume (A)
- extractVolume (A)
- getPathForVolume
- getSolidFireVolumeAccessGroupIds
- getSolidFireVolumeSize
- getUploadParamsForVolume
- getVolumeiScsiName
- listElastistorVolume
- listVolumes
- listVolumesMetrics
- migrateVolume (A)
- recoverVolume
- resizeVolume (A)
- updateVolume (A)
- uploadVolume (A)
VPN
- createRemoteAccessVpn (A)
- createVpnConnection (A)
- createVpnCustomerGateway (A)
- createVpnGateway (A)
- deleteRemoteAccessVpn (A)
- deleteVpnConnection (A)
- deleteVpnCustomerGateway (A)
- deleteVpnGateway (A)
- listRemoteAccessVpns
- listVpnConnections
- listVpnCustomerGateways
- listVpnGateways
- resetVpnConnection (A)
- updateRemoteAccessVpn (A)
- updateVpnConnection (A)
- updateVpnCustomerGateway (A)
- updateVpnGateway (A)
Role
- createProjectRole
- createProjectRolePermission
- createRole
- createRolePermission
- deleteProjectRole
- deleteProjectRolePermission
- deleteRole
- deleteRolePermission
- importRole
- listProjectRolePermissions
- listProjectRoles
- listRolePermissions
- listRoles
- updateProjectRole
- updateProjectRolePermission
- updateRole
- updateRolePermission
Backup and Recovery
- assignVirtualMachineToBackupOffering (A)
- createBackup (A)
- createBackupSchedule
- deleteBackup (A)
- deleteBackupOffering
- deleteBackupSchedule
- importBackupOffering (A)
- listBackupOfferings
- listBackupProviderOfferings
- listBackupProviders
- listBackupSchedule
- listBackups
- removeVirtualMachineFromBackupOffering (A)
- restoreBackup (A)
- restoreVolumeFromBackupAndAttachToVM (A)
- updateBackupOffering
- updateBackupSchedule
Zone
Template
Snapshot
Management
- changeOutOfBandManagementPassword (A)
- configureOutOfBandManagement
- createManagementNetworkIpRange (A)
- deleteManagementNetworkIpRange (A)
- disableOutOfBandManagementForCluster (A)
- disableOutOfBandManagementForHost (A)
- disableOutOfBandManagementForZone (A)
- enableOutOfBandManagementForCluster (A)
- enableOutOfBandManagementForHost (A)
- enableOutOfBandManagementForZone (A)
- issueOutOfBandManagementPowerAction (A)
- listManagementServers
- updatePodManagementNetworkIpRange (A)
Usage
Kubernetes Service
- addKubernetesSupportedVersion
- createKubernetesCluster (A)
- deleteKubernetesCluster (A)
- deleteKubernetesSupportedVersion (A)
- getKubernetesClusterConfig
- listKubernetesClusters
- listKubernetesSupportedVersions
- scaleKubernetesCluster (A)
- startKubernetesCluster (A)
- stopKubernetesCluster (A)
- updateKubernetesSupportedVersion
- upgradeKubernetesCluster (A)