Apache CloudStack API Documentation (4.13.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.
API Discovery
Account
Address
Annotations
Async job
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)
Baremetal
Certificate
Cloud Identifier
Cloudian
Cluster
External Firewalls
External Load Balancers
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)
Guest OS
Host
- addBaremetalHost
- addGloboDnsHost (A)
- addHost
- addSecondaryStorage
- cancelHostMaintenance (A)
- configureHAForHost (A)
- dedicateHost (A)
- deleteHost
- disableHAForHost (A)
- enableHAForHost (A)
- findHostsForMigration
- listDedicatedHosts
- listHostHAProviders
- listHostHAResources
- listHostTags
- listHosts
- listHostsMetrics
- prepareHostForMaintenance (A)
- reconnectHost (A)
- releaseDedicatedHost (A)
- releaseHostReservation (A)
- updateHost
- updateHostPassword
ISO
Image Store
Internal LB
Load Balancer
- addF5LoadBalancer (A)
- assignCertToLoadBalancer (A)
- assignToGlobalLoadBalancerRule (A)
- assignToLoadBalancerRule (A)
- configureF5LoadBalancer (A)
- createGlobalLoadBalancerRule (A)
- createLBHealthCheckPolicy (A)
- createLBStickinessPolicy (A)
- createLoadBalancer (A)
- createLoadBalancerRule (A)
- deleteF5LoadBalancer (A)
- deleteGlobalLoadBalancerRule (A)
- deleteLBHealthCheckPolicy (A)
- deleteLBStickinessPolicy (A)
- deleteLoadBalancer (A)
- deleteLoadBalancerRule (A)
- deleteServicePackageOffering
- deleteSslCert
- listF5LoadBalancers
- listGlobalLoadBalancerRules
- listLBHealthCheckPolicies
- listLBStickinessPolicies
- listLoadBalancerRuleInstances
- listLoadBalancerRules
- listLoadBalancers
- listRegisteredServicePackages
- listSslCerts
- removeCertFromLoadBalancer (A)
- removeFromGlobalLoadBalancerRule (A)
- removeFromLoadBalancerRule (A)
- updateGlobalLoadBalancerRule (A)
- updateLBHealthCheckPolicy (A)
- updateLBStickinessPolicy (A)
- updateLoadBalancer (A)
- updateLoadBalancerRule (A)
- uploadSslCert
Management
- changeOutOfBandManagementPassword (A)
- configureOutOfBandManagement
- createManagementNetworkIpRange (A)
- deleteManagementNetworkIpRange (A)
- disableOutOfBandManagementForCluster (A)
- disableOutOfBandManagementForHost (A)
- disableOutOfBandManagementForZone (A)
- enableOutOfBandManagementForCluster (A)
- enableOutOfBandManagementForHost (A)
- enableOutOfBandManagementForZone (A)
- issueOutOfBandManagementPowerAction (A)
- listManagementServers
Metrics
Misc
NAT
Network
- addNetworkDevice
- addNetworkServiceProvider (A)
- createNetwork
- createNetworkACL (A)
- createNetworkACLList (A)
- createNetworkOffering
- createPhysicalNetwork (A)
- createServiceInstance (A)
- createStorageNetworkIpRange (A)
- dedicatePublicIpRange
- deleteNetwork (A)
- deleteNetworkACL (A)
- deleteNetworkACLList (A)
- deleteNetworkDevice
- deleteNetworkOffering
- deleteNetworkServiceProvider (A)
- deletePhysicalNetwork (A)
- deleteStorageNetworkIpRange (A)
- listBrocadeVcsDeviceNetworks
- listF5LoadBalancerNetworks
- listNetscalerLoadBalancerNetworks
- listNetworkACLLists
- listNetworkACLs
- listNetworkDevice
- listNetworkIsolationMethods
- listNetworkOfferings
- listNetworkServiceProviders
- listNetworks
- listNiciraNvpDeviceNetworks
- 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)
Network Appliances
- addBigSwitchBcfDevice (A)
- addBrocadeVcsDevice (A)
- addCiscoAsa1000vResource
- addCiscoVnmcResource
- addNetscalerLoadBalancer (A)
- addNiciraNvpDevice (A)
- addStratosphereSsp
- configureNetscalerLoadBalancer (A)
- deleteBigSwitchBcfDevice (A)
- deleteBrocadeVcsDevice (A)
- deleteCiscoAsa1000vResource
- deleteCiscoNexusVSM (A)
- deleteCiscoVnmcResource
- deleteNetscalerControlCenter
- deleteNetscalerLoadBalancer (A)
- deleteNiciraNvpDevice (A)
- deleteStratosphereSsp
- deployNetscalerVpx (A)
- disableCiscoNexusVSM (A)
- enableCiscoNexusVSM (A)
- listBigSwitchBcfDevices
- listBrocadeVcsDevices
- listCiscoAsa1000vResources
- listCiscoNexusVSMs
- listCiscoVnmcResources
- listNetscalerControlCenter
- listNetscalerLoadBalancers
- listNiciraNvpDevices
- registerNetscalerControlCenter (A)
- registerNetscalerServicePackage
- stopNetScalerVpx (A)
Network Providers
Pod
Project
Quota
Resource metadata
Resource tags
Role
Security Group
Service Offering
Snapshot
Swift
System Capacity
Template
- copyTemplate (A)
- createTemplate (A)
- deleteTemplate (A)
- extractTemplate (A)
- getUploadParamsForTemplate
- listTemplateOvfProperties
- listTemplatePermissions
- listTemplates
- prepareTemplate
- quotaEmailTemplateList
- quotaEmailTemplateUpdate
- registerTemplate
- updateTemplate
- updateTemplatePermissions
- upgradeRouterTemplate
UCS
Usage
VLAN
VPC
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)
Virtual Machine
- addNicToVirtualMachine (A)
- assignVirtualMachine
- changeServiceForVirtualMachine
- cleanVMReservations (A)
- deployVirtualMachine (A)
- destroyVirtualMachine (A)
- expungeVirtualMachine (A)
- getVMPassword
- listInternalLoadBalancerVMs
- 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)
- updateDefaultNicForVirtualMachine (A)
- updateVirtualMachine
Volume
- attachVolume (A)
- createVolume (A)
- deleteVolume
- detachVolume (A)
- extractVolume (A)
- getPathForVolume
- getSolidFireVolumeAccessGroupIds
- getSolidFireVolumeSize
- getUploadParamsForVolume
- getVolumeiScsiName
- listElastistorVolume
- listVolumes
- listVolumesMetrics
- migrateVolume (A)
- resizeVolume (A)
- updateVolume (A)
- uploadVolume (A)