Apache CloudStack API Documentation (4.20.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.
Network
- addGloboDnsHost (A)
- addNetworkServiceProvider (A)
- addOpenDaylightController (A)
- addTrafficMonitor
- addTrafficType (A)
- changeBgpPeersForNetwork (A)
- createGuestNetworkIpv6Prefix (A)
- createIpv4SubnetForGuestNetwork (A)
- createNetwork
- createNetworkPermissions
- createPhysicalNetwork (A)
- createServiceInstance (A)
- createStorageNetworkIpRange (A)
- dedicatePublicIpRange
- deleteCiscoNexusVSM (A)
- deleteGuestNetworkIpv6Prefix (A)
- deleteIpv4SubnetForGuestNetwork (A)
- deleteNetwork (A)
- deleteNetworkServiceProvider (A)
- deleteOpenDaylightController (A)
- deletePhysicalNetwork (A)
- deleteStorageNetworkIpRange (A)
- deleteTrafficMonitor
- deleteTrafficType (A)
- disableCiscoNexusVSM (A)
- enableCiscoNexusVSM (A)
- listCiscoNexusVSMs
- listGuestNetworkIpv6Prefixes
- listIpv4SubnetsForGuestNetwork
- listNetworkIsolationMethods
- listNetworkPermissions
- listNetworkProtocols
- listNetworkServiceProviders
- listNetworks
- listOpenDaylightControllers
- listPhysicalNetworks
- listStorageNetworkIpRange
- listSupportedNetworkServices
- listTrafficMonitors
- listTrafficTypeImplementors
- listTrafficTypes
- migrateNetwork (A)
- releasePublicIpRange
- removeNetworkPermissions
- resetNetworkPermissions
- restartNetwork (A)
- updateNetwork (A)
- updateNetworkServiceProvider (A)
- updatePhysicalNetwork (A)
- updateStorageNetworkIpRange (A)
- updateTrafficType (A)
Tungsten
- addTungstenFabricNetworkGatewayToLogicalRouter (A)
- addTungstenFabricPolicyRule (A)
- applyTungstenFabricPolicy (A)
- applyTungstenFabricTag (A)
- configTungstenFabricService
- createTungstenFabricAddressGroup (A)
- createTungstenFabricApplicationPolicySet (A)
- createTungstenFabricFirewallPolicy (A)
- createTungstenFabricFirewallRule (A)
- createTungstenFabricLogicalRouter (A)
- createTungstenFabricManagementNetwork
- createTungstenFabricPolicy (A)
- createTungstenFabricProvider
- createTungstenFabricPublicNetwork
- createTungstenFabricServiceGroup (A)
- createTungstenFabricTag (A)
- createTungstenFabricTagType (A)
- deleteTungstenFabricAddressGroup (A)
- deleteTungstenFabricApplicationPolicySet (A)
- deleteTungstenFabricFirewallPolicy (A)
- deleteTungstenFabricFirewallRule (A)
- deleteTungstenFabricLogicalRouter (A)
- deleteTungstenFabricPolicy (A)
- deleteTungstenFabricServiceGroup (A)
- deleteTungstenFabricTag (A)
- deleteTungstenFabricTagType (A)
- listTungstenFabricAddressGroup
- listTungstenFabricApplicationPolicySet
- listTungstenFabricFirewallPolicy
- listTungstenFabricFirewallRule
- listTungstenFabricLBHealthMonitor
- listTungstenFabricLogicalRouter
- listTungstenFabricNetwork
- listTungstenFabricNic
- listTungstenFabricPolicy
- listTungstenFabricPolicyRule
- listTungstenFabricProviders
- listTungstenFabricServiceGroup
- listTungstenFabricTag
- listTungstenFabricTagType
- listTungstenFabricVm
- removeTungstenFabricNetworkGatewayFromLogicalRouter (A)
- removeTungstenFabricPolicy (A)
- removeTungstenFabricPolicyRule (A)
- removeTungstenFabricTag (A)
- synchronizeTungstenFabricData
- updateTungstenFabricLBHealthMonitor (A)
Virtual Machine
- addNicToVirtualMachine (A)
- assignVirtualMachine
- assignVirtualMachineToBackupOffering (A)
- changeServiceForVirtualMachine (D)
- cleanVMReservations (A)
- createVMSchedule
- deleteVMSchedule
- deployVirtualMachine (A)
- destroyVirtualMachine (A)
- expungeVirtualMachine (A)
- getVMPassword
- getVirtualMachineUserData
- importUnmanagedInstance (A)
- importVm (A)
- listUnmanagedInstances
- listVMSchedule
- listVirtualMachines
- listVirtualMachinesMetrics
- listVirtualMachinesUsageHistory
- listVmsForImport
- migrateVirtualMachine (A)
- migrateVirtualMachineWithVolume (A)
- rebootVirtualMachine (A)
- recoverVirtualMachine
- removeNicFromVirtualMachine (A)
- removeVirtualMachineFromBackupOffering (A)
- resetPasswordForVirtualMachine (A)
- resetSSHKeyForVirtualMachine (A)
- resetUserDataForVirtualMachine
- restoreVirtualMachine (A)
- revertToVMSnapshot (A)
- scaleVirtualMachine (A)
- startVirtualMachine (A)
- stopVirtualMachine (A)
- unmanageVirtualMachine (A)
- updateDefaultNicForVirtualMachine (A)
- updateVMSchedule
- updateVirtualMachine
Load Balancer
- assignCertToLoadBalancer (A)
- assignToGlobalLoadBalancerRule (A)
- assignToLoadBalancerRule (A)
- createGlobalLoadBalancerRule (A)
- createLBHealthCheckPolicy (A)
- createLBStickinessPolicy (A)
- createLoadBalancer (A)
- createLoadBalancerRule (A)
- deleteGlobalLoadBalancerRule (A)
- deleteLBHealthCheckPolicy (A)
- deleteLBStickinessPolicy (A)
- deleteLoadBalancer (A)
- deleteLoadBalancerRule (A)
- deleteServicePackageOffering
- deployNetscalerVpx (A)
- getLoadBalancerSslCertificate
- listGlobalLoadBalancerRules
- listLBHealthCheckPolicies
- listLBStickinessPolicies
- listLoadBalancerRuleInstances
- listLoadBalancerRules
- listLoadBalancers
- listRegisteredServicePackages
- removeCertFromLoadBalancer (A)
- removeFromGlobalLoadBalancerRule (A)
- removeFromLoadBalancerRule (A)
- stopNetScalerVpx (A)
- updateGlobalLoadBalancerRule (A)
- updateLBHealthCheckPolicy (A)
- updateLBStickinessPolicy (A)
- updateLoadBalancer (A)
- updateLoadBalancerRule (A)
Volume
- assignVolume
- attachVolume (A)
- changeOfferingForVolume (A)
- checkVolume (A)
- createVolume (A)
- deleteVolume
- destroyVolume (A)
- detachVolume (A)
- extractVolume (A)
- getPathForVolume
- getUploadParamsForVolume
- getVolumeiScsiName
- importVolume (A)
- listElastistorVolume
- listVolumes
- listVolumesForImport
- listVolumesUsageHistory
- migrateVolume (A)
- recoverVolume
- resizeVolume (A)
- restoreVolumeFromBackupAndAttachToVM (A)
- unmanageVolume (A)
- updateVolume (A)
- uploadVolume (A)
Project
- activateProject (A)
- addAccountToProject (A)
- addUserToProject (A)
- createProject (A)
- createProjectRole
- createProjectRolePermission
- deleteAccountFromProject (A)
- deleteProject (A)
- deleteProjectInvitation (A)
- deleteProjectRole
- deleteProjectRolePermission
- deleteUserFromProject (A)
- listProjectAccounts
- listProjectInvitations
- listProjectRolePermissions
- listProjectRoles
- listProjects
- suspendProject (A)
- updateProject (A)
- updateProjectInvitation (A)
- updateProjectRole
- updateProjectRolePermission
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)
Zone
- addVmwareDc
- createIpv4SubnetForZone (A)
- createZone
- dedicateIpv4SubnetForZone (A)
- dedicateZone (A)
- deleteIpv4SubnetForZone (A)
- deleteZone
- disableHAForZone (A)
- enableHAForZone (A)
- listDedicatedZones
- listIpv4SubnetsForZone
- listVmwareDcVms
- listVmwareDcs
- listZones
- releaseDedicatedZone (A)
- releaseIpv4SubnetForZone (A)
- removeVmwareDc
- updateIpv4SubnetForZone (A)
- updateVmwareDc
- updateZone
VPN
- addVpnUser (A)
- createRemoteAccessVpn (A)
- createVpnConnection (A)
- createVpnCustomerGateway (A)
- createVpnGateway (A)
- deleteRemoteAccessVpn (A)
- deleteVpnConnection (A)
- deleteVpnCustomerGateway (A)
- deleteVpnGateway (A)
- listRemoteAccessVpns
- listVpnConnections
- listVpnCustomerGateways
- listVpnGateways
- listVpnUsers
- removeVpnUser (A)
- resetVpnConnection (A)
- updateRemoteAccessVpn (A)
- updateVpnConnection (A)
- updateVpnCustomerGateway (A)
- updateVpnGateway (A)
Image Store
- addImageStore
- addImageStoreS3
- addSecondaryStorage
- addSwift
- createSecondaryStagingStore
- createSecondaryStorageSelector
- deleteImageStore
- deleteSecondaryStagingStore
- downloadImageStoreObject (A)
- listImageStoreObjects
- listImageStores
- listSecondaryStagingStores
- listSecondaryStorageSelectors
- listSwifts
- migrateResourceToAnotherSecondaryStorage (A)
- migrateSecondaryStorageData (A)
- removeSecondaryStorageSelector
- updateCloudToUseObjectStore
- updateImageStore
- updateSecondaryStorageSelector
Firewall
- createEgressFirewallRule (A)
- createFirewallRule (A)
- createIpv6FirewallRule (A)
- createPortForwardingRule (A)
- createRoutingFirewallRule (A)
- deleteEgressFirewallRule (A)
- deleteFirewallRule (A)
- deleteIpv6FirewallRule (A)
- deletePortForwardingRule (A)
- deleteRoutingFirewallRule (A)
- listEgressFirewallRules
- listFirewallRules
- listIpv6FirewallRules
- listPortForwardingRules
- listRoutingFirewallRules
- updateEgressFirewallRule (A)
- updateFirewallRule (A)
- updateIpv6FirewallRule (A)
- updatePortForwardingRule (A)
- updateRoutingFirewallRule (A)
Host
- addHost
- cancelHostAsDegraded (A)
- cancelHostMaintenance (A)
- configureHAForHost (A)
- declareHostAsDegraded (A)
- deleteHost
- disableHAForHost (A)
- enableHAForHost (A)
- findHostsForMigration
- listDedicatedHosts
- listHostHAProviders
- listHostHAResources
- listHostTags
- listHosts
- prepareHostForMaintenance (A)
- reconnectHost (A)
- releaseHostReservation (A)
- updateHost
- updateHostPassword
User
Backup and Recovery
- addBackupRepository
- createBackup (A)
- createBackupSchedule
- deleteBackup (A)
- deleteBackupOffering
- deleteBackupRepository
- deleteBackupSchedule
- importBackupOffering (A)
- listBackupOfferings
- listBackupProviderOfferings
- listBackupProviders
- listBackupRepositories
- listBackupSchedule
- listBackups
- restoreBackup (A)
- updateBackupOffering
- updateBackupSchedule
Snapshot
- archiveSnapshot (A)
- copySnapshot (A)
- createSnapshot (A)
- createSnapshotFromVMSnapshot (A)
- createSnapshotPolicy
- createVMSnapshot (A)
- deleteSnapshot (A)
- deleteSnapshotPolicies
- deleteVMSnapshot (A)
- extractSnapshot (A)
- getVolumeSnapshotDetails
- listSnapshotPolicies
- listSnapshots
- listVMSnapshot
- revertSnapshot (A)
- updateSnapshotPolicy (A)
Configuration
- addLdapConfiguration
- deleteLdapConfiguration
- getApiLimit
- listCapabilities
- listConfigurationGroups
- listConfigurations
- listDeploymentPlanners
- listHypervisorCapabilities
- listHypervisors
- listLdapConfigurations
- quotaListEmailConfiguration
- resetApiLimit
- resetConfiguration
- updateConfiguration
- updateHypervisorCapabilities
Template
Storage Pool
- cancelStorageMaintenance (A)
- changeStoragePoolScope (A)
- createStoragePool
- deleteStoragePool
- enableStorageMaintenance (A)
- findStoragePoolsForMigration
- listAffectedVmsForStorageScopeChange
- listStoragePoolObjects
- listStoragePools
- listStoragePoolsMetrics
- listStorageProviders
- syncStoragePool (A)
- updateStorageCapabilities
- updateStoragePool
Kubernetes Service
- addKubernetesSupportedVersion
- addVirtualMachinesToKubernetesCluster
- createKubernetesCluster (A)
- deleteKubernetesCluster (A)
- deleteKubernetesSupportedVersion (A)
- getKubernetesClusterConfig
- listKubernetesClusters
- listKubernetesSupportedVersions
- removeVirtualMachinesFromKubernetesCluster
- scaleKubernetesCluster (A)
- startKubernetesCluster (A)
- stopKubernetesCluster (A)
- updateKubernetesSupportedVersion
- upgradeKubernetesCluster (A)
VPC
Shared FileSystem
- changeSharedFileSystemDiskOffering (A)
- changeSharedFileSystemServiceOffering (A)
- createSharedFileSystem (A)
- destroySharedFileSystem (A)
- expungeSharedFileSystem (A)
- listSharedFileSystemProviders
- listSharedFileSystems
- recoverSharedFileSystem
- restartSharedFileSystem (A)
- startSharedFileSystem (A)
- stopSharedFileSystem (A)
- updateSharedFileSystem
Quota
Role
ISO
Authentication
Router
Pod
Network ACL
Certificate
Baremetal
Out-of-band Management
- changeOutOfBandManagementPassword (A)
- configureOutOfBandManagement
- disableOutOfBandManagementForCluster (A)
- disableOutOfBandManagementForHost (A)
- disableOutOfBandManagementForZone (A)
- enableOutOfBandManagementForCluster (A)
- enableOutOfBandManagementForHost (A)
- enableOutOfBandManagementForZone (A)
- issueOutOfBandManagementPowerAction (A)