Apache CloudStack API Documentation (4.18.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.
(D) implies that the command is deprecated.
(*) implies element has a child.
Load Balancer
- addNetscalerLoadBalancer (A)
- assignCertToLoadBalancer (A)
- assignToGlobalLoadBalancerRule (A)
- assignToLoadBalancerRule (A)
- configureInternalLoadBalancerElement (A)
- configureNetscalerLoadBalancer (A)
- createGlobalLoadBalancerRule (A)
- createInternalLoadBalancerElement (A)
- createLBHealthCheckPolicy (A)
- createLBStickinessPolicy (A)
- createLoadBalancer (A)
- createLoadBalancerRule (A)
- deleteGlobalLoadBalancerRule (A)
- deleteLBHealthCheckPolicy (A)
- deleteLBStickinessPolicy (A)
- deleteLoadBalancer (A)
- deleteLoadBalancerRule (A)
- deleteNetscalerControlCenter
- deleteNetscalerLoadBalancer (A)
- deleteServicePackageOffering
- deleteSslCert
- deployNetscalerVpx (A)
- getLoadBalancerSslCertificate
- listGlobalLoadBalancerRules
- listInternalLoadBalancerElements
- listLBHealthCheckPolicies
- listLBStickinessPolicies
- listLoadBalancerRuleInstances
- listLoadBalancerRules
- listLoadBalancers
- listNetscalerControlCenter
- listNetscalerLoadBalancerNetworks
- listNetscalerLoadBalancers
- listRegisteredServicePackages
- listSslCerts
- removeCertFromLoadBalancer (A)
- removeFromGlobalLoadBalancerRule (A)
- removeFromLoadBalancerRule (A)
- stopNetScalerVpx (A)
- updateGlobalLoadBalancerRule (A)
- updateLBHealthCheckPolicy (A)
- updateLBStickinessPolicy (A)
- updateLoadBalancer (A)
- updateLoadBalancerRule (A)
- uploadSslCert
Network
- addNetworkDevice
- addNetworkServiceProvider (A)
- addOpenDaylightController (A)
- createGuestNetworkIpv6Prefix (A)
- createManagementNetworkIpRange (A)
- createNetwork
- createNetworkPermissions
- createPhysicalNetwork (A)
- createServiceInstance (A)
- createStorageNetworkIpRange (A)
- createTungstenFabricManagementNetwork
- createTungstenFabricPublicNetwork
- dedicatePublicIpRange
- deleteGuestNetworkIpv6Prefix (A)
- deleteManagementNetworkIpRange (A)
- deleteNetwork (A)
- deleteNetworkDevice
- deleteNetworkServiceProvider (A)
- deleteOpenDaylightController (A)
- deletePhysicalNetwork (A)
- deleteStorageNetworkIpRange (A)
- listBrocadeVcsDeviceNetworks
- listGuestNetworkIpv6Prefixes
- listNetworkDevice
- listNetworkPermissions
- listNetworkServiceProviders
- listNetworks
- listNiciraNvpDeviceNetworks
- listOpenDaylightControllers
- listPhysicalNetworks
- listStorageNetworkIpRange
- listSupportedNetworkServices
- listTungstenFabricNetwork
- migrateNetwork (A)
- moveNetworkAclItem (A)
- releasePublicIpRange
- removeNetworkPermissions
- resetNetworkPermissions
- restartNetwork (A)
- updateNetwork (A)
- updateNetworkServiceProvider (A)
- updatePhysicalNetwork (A)
- updateStorageNetworkIpRange (A)
Virtual Machine
- addNicToVirtualMachine (A)
- assignVirtualMachine
- assignVirtualMachineToBackupOffering (A)
- changeServiceForVirtualMachine (D)
- cleanVMReservations (A)
- createSnapshotFromVMSnapshot (A)
- createVMSnapshot (A)
- deleteVMSnapshot (A)
- deployVirtualMachine (A)
- destroyVirtualMachine (A)
- expungeVirtualMachine (A)
- getVMPassword
- getVirtualMachineUserData
- importUnmanagedInstance (A)
- listInternalLoadBalancerVMs
- listUnmanagedInstances
- listVMSnapshot
- listVirtualMachines
- listVirtualMachinesMetrics
- listVirtualMachinesUsageHistory
- migrateVirtualMachine (A)
- migrateVirtualMachineWithVolume (A)
- rebootVirtualMachine (A)
- recoverVirtualMachine
- removeNicFromVirtualMachine (A)
- removeVirtualMachineFromBackupOffering (A)
- resetPasswordForVirtualMachine (A)
- resetSSHKeyForVirtualMachine (A)
- resetUserDataForVirtualMachine
- restoreVirtualMachine (A)
- restoreVolumeFromBackupAndAttachToVM (A)
- revertToVMSnapshot (A)
- scaleVirtualMachine (A)
- startInternalLoadBalancerVM (A)
- startVirtualMachine (A)
- stopInternalLoadBalancerVM (A)
- stopVirtualMachine (A)
- unmanageVirtualMachine (A)
- updateDefaultNicForVirtualMachine (A)
- updateVMAffinityGroup (A)
- updateVirtualMachine
Tungsten
- addTungstenFabricPolicyRule (A)
- applyTungstenFabricPolicy (A)
- applyTungstenFabricTag (A)
- configTungstenFabricService
- createTungstenFabricAddressGroup (A)
- createTungstenFabricApplicationPolicySet (A)
- createTungstenFabricPolicy (A)
- createTungstenFabricProvider
- createTungstenFabricServiceGroup (A)
- createTungstenFabricTag (A)
- createTungstenFabricTagType (A)
- deleteTungstenFabricAddressGroup (A)
- deleteTungstenFabricApplicationPolicySet (A)
- deleteTungstenFabricPolicy (A)
- deleteTungstenFabricServiceGroup (A)
- deleteTungstenFabricTag (A)
- deleteTungstenFabricTagType (A)
- listTungstenFabricAddressGroup
- listTungstenFabricApplicationPolicySet
- listTungstenFabricLBHealthMonitor
- listTungstenFabricNic
- listTungstenFabricPolicy
- listTungstenFabricPolicyRule
- listTungstenFabricProviders
- listTungstenFabricServiceGroup
- listTungstenFabricTag
- listTungstenFabricTagType
- listTungstenFabricVm
- removeTungstenFabricPolicy (A)
- removeTungstenFabricPolicyRule (A)
- removeTungstenFabricTag (A)
- synchronizeTungstenFabricData
- updateTungstenFabricLBHealthMonitor (A)
Host
- addBaremetalHost
- addGloboDnsHost (A)
- addHost
- addSecondaryStorage
- cancelHostAsDegraded (A)
- cancelHostMaintenance (A)
- configureHAForHost (A)
- declareHostAsDegraded (A)
- dedicateHost (A)
- deleteHost
- disableHAForHost (A)
- disableOutOfBandManagementForHost (A)
- enableHAForHost (A)
- enableOutOfBandManagementForHost (A)
- findHostsForMigration
- listDedicatedHosts
- listHostHAProviders
- listHostHAResources
- listHostTags
- listHosts
- listHostsMetrics
- migrateSecondaryStorageData (A)
- prepareHostForMaintenance (A)
- reconnectHost (A)
- releaseDedicatedHost (A)
- releaseHostReservation (A)
- updateHost
- updateHostPassword
Firewall
- addPaloAltoFirewall (A)
- configurePaloAltoFirewall (A)
- createEgressFirewallRule (A)
- createFirewallRule (A)
- createIpv6FirewallRule (A)
- createPortForwardingRule (A)
- createTungstenFabricFirewallPolicy (A)
- createTungstenFabricFirewallRule (A)
- deleteEgressFirewallRule (A)
- deleteFirewallRule (A)
- deleteIpv6FirewallRule (A)
- deletePaloAltoFirewall (A)
- deletePortForwardingRule (A)
- deleteTungstenFabricFirewallPolicy (A)
- deleteTungstenFabricFirewallRule (A)
- listEgressFirewallRules
- listFirewallRules
- listIpv6FirewallRules
- listPaloAltoFirewallNetworks
- listPaloAltoFirewalls
- listPortForwardingRules
- listTungstenFabricFirewallPolicy
- listTungstenFabricFirewallRule
- updateEgressFirewallRule (A)
- updateFirewallRule (A)
- updateIpv6FirewallRule (A)
- updatePortForwardingRule (A)
User
- addUserToProject (A)
- addVpnUser (A)
- createUser
- deleteUser
- deleteUserData
- deleteUserFromProject (A)
- disableUser (A)
- enableUser
- getUser
- getUserKeys
- importLdapUsers
- listLdapUsers
- listUserData
- listUserTwoFactorAuthenticatorProviders
- listUsers
- listVpnUsers
- lockUser
- moveUser
- registerUserData
- registerUserKeys
- removeVpnUser (A)
- setupUserTwoFactorAuthentication
- updateUser
- validateUserTwoFactorAuthenticationCode
Volume
- assignVolume
- attachVolume (A)
- changeOfferingForVolume (A)
- createVolume (A)
- deleteVolume
- destroyVolume (A)
- detachVolume (A)
- extractVolume (A)
- getPathForVolume
- getSolidFireVolumeAccessGroupIds
- getSolidFireVolumeSize
- getUploadParamsForVolume
- getVolumeSnapshotDetails
- getVolumeiScsiName
- listElastistorVolume
- listVolumes
- listVolumesMetrics
- listVolumesUsageHistory
- migrateVolume (A)
- recoverVolume
- resizeVolume (A)
- updateVolume (A)
- uploadVolume (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)
- updateCondition (A)
Template
- copyTemplate (A)
- createTemplate (A)
- deleteTemplate (A)
- extractTemplate (A)
- getUploadParamsForTemplate
- linkUserDataToTemplate
- listTemplateDirectDownloadCertificates
- listTemplatePermissions
- listTemplates
- prepareTemplate
- provisionTemplateDirectDownloadCertificate
- quotaEmailTemplateList
- quotaEmailTemplateUpdate
- registerTemplate
- revokeTemplateDirectDownloadCertificate
- updateTemplate
- updateTemplatePermissions
- upgradeRouterTemplate
- uploadTemplateDirectDownloadCertificate
Cluster
- addCluster
- createKubernetesCluster (A)
- dedicateCluster (A)
- deleteCluster
- deleteKubernetesCluster (A)
- disableHAForCluster (A)
- enableHAForCluster (A)
- getKubernetesClusterConfig
- listClusters
- listClustersMetrics
- listDedicatedClusters
- listKubernetesClusters
- releaseDedicatedCluster (A)
- scaleKubernetesCluster (A)
- startKubernetesCluster (A)
- stopKubernetesCluster (A)
- updateCluster
- upgradeKubernetesCluster (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
VPC
Account
- addAccountToProject (A)
- createAccount
- deleteAccount (A)
- deleteAccountFromProject (A)
- disableAccount (A)
- enableAccount
- getSolidFireAccountId
- isAccountAllowedToCreateOfferingsWithTags
- ldapCreateAccount
- linkAccountToLdap
- listAccounts
- listAndSwitchSamlAccount
- listProjectAccounts
- lockAccount
- markDefaultZoneForAccount (A)
- updateAccount
Router
- addTungstenFabricNetworkGatewayToLogicalRouter (A)
- changeServiceForRouter
- configureVirtualRouterElement (A)
- createTungstenFabricLogicalRouter (A)
- createVirtualRouterElement (A)
- deleteTungstenFabricLogicalRouter (A)
- destroyRouter (A)
- getRouterHealthCheckResults
- listRouters
- listTungstenFabricLogicalRouter
- listVirtualRouterElements
- rebootRouter (A)
- removeTungstenFabricNetworkGatewayFromLogicalRouter (A)
- startRouter (A)
- stopRouter (A)