openapi: 3.2.0
info:
  title: Apache CloudStack API
  summary: Apache CloudStack API, generated from listApis.
  description: |-
    OpenAPI rendering of the Apache CloudStack API, generated from the `listApis`
    command.

    **Paths in this document are synthetic.** CloudStack exposes a single endpoint
    and selects the command with a query parameter, which OpenAPI cannot express:
    every request actually goes to `{server}?command=<operationId>`. Each operation
    is therefore keyed by a path named after its command, and carries a required
    `command` parameter pinned to that command. A client generated from this
    document must send the `command` parameter and ignore the path segment.

    Every response body is wrapped by CloudStack in a single `<command>response`
    key, which is reflected in the schemas. `listApis` describes the *entity* a
    command returns rather than that envelope, so for non-list commands the payload
    is modelled as either the entity itself or the entity nested under a
    command-specific key.

    Requests are authenticated with `apiKey` plus a `signature` computed from the
    request, or with a `sessionkey` obtained from `login`.
  license:
    name: Apache License 2.0
    identifier: Apache-2.0
  version: 4.23.0.0
servers:
- url: http://localhost:8081/client/api
  name: signing-proxy
  description: Local signing proxy (scripts/signing_proxy.py / docker compose up). Signs requests for you.
- url: '{endpoint}'
  name: cloudstack
  description: CloudStack API endpoint directly, usually the management server plus `/client/api` (needs apiKey + signature).
  variables:
    endpoint:
      default: http://localhost:8080/client/api
security:
- apiKey: []
  signature: []
- sessionKey: []
tags:
- name: ASNRange
  description: 3 commands acting on ASNRange.
- name: ASNumber
  description: 2 commands acting on ASNumber.
- name: Account
  description: 10 commands acting on Account.
- name: AccountAllowedToCreateOfferingsWithTag
  description: 1 command acting on AccountAllowedToCreateOfferingsWithTag.
- name: AccountToLdap
  description: 1 command acting on AccountToLdap.
- name: AffectedVmsForStorageScopeChange
  description: 1 command acting on AffectedVmsForStorageScopeChange.
- name: AffinityGroup
  description: 5 commands acting on AffinityGroup.
- name: AffinityGroupType
  description: 1 command acting on AffinityGroupType.
- name: Alert
  description: 4 commands acting on Alert.
- name: AlertType
  description: 1 command acting on AlertType.
- name: Annotation
  description: 3 commands acting on Annotation.
- name: AnnotationVisibility
  description: 1 command acting on AnnotationVisibility.
- name: Api
  description: 1 command acting on Api.
- name: ApiLimit
  description: 2 commands acting on ApiLimit.
- name: AsyncJob
  description: 1 command acting on AsyncJob.
- name: AsyncJobResult
  description: 1 command acting on AsyncJobResult.
- name: AutoScalePolicy
  description: 4 commands acting on AutoScalePolicy.
- name: AutoScaleVmGroup
  description: 6 commands acting on AutoScaleVmGroup.
- name: AutoScaleVmProfile
  description: 4 commands acting on AutoScaleVmProfile.
- name: Backup
  description: 5 commands acting on Backup.
- name: BackupOffering
  description: 8 commands acting on BackupOffering.
- name: BackupProvider
  description: 1 command acting on BackupProvider.
- name: BackupProviderOffering
  description: 1 command acting on BackupProviderOffering.
- name: BackupRepository
  description: 4 commands acting on BackupRepository.
- name: BackupSchedule
  description: 4 commands acting on BackupSchedule.
- name: BackupServiceJob
  description: 1 command acting on BackupServiceJob.
- name: BaremetalDhcp
  description: 2 commands acting on BaremetalDhcp.
- name: BaremetalHost
  description: 1 command acting on BaremetalHost.
- name: BaremetalPxeKickStartServer
  description: 1 command acting on BaremetalPxeKickStartServer.
- name: BaremetalPxePingServer
  description: 1 command acting on BaremetalPxePingServer.
- name: BaremetalPxeServer
  description: 1 command acting on BaremetalPxeServer.
- name: BaremetalRct
  description: 3 commands acting on BaremetalRct.
- name: BgpPeer
  description: 6 commands acting on BgpPeer.
- name: BgpPeersForVpc
  description: 1 command acting on BgpPeersForVpc.
- name: BigSwitchBcfDevice
  description: 3 commands acting on BigSwitchBcfDevice.
- name: BrocadeVcsDevice
  description: 3 commands acting on BrocadeVcsDevice.
- name: Bucket
  description: 4 commands acting on Bucket.
- name: CAProvider
  description: 1 command acting on CAProvider.
- name: Capability
  description: 1 command acting on Capability.
- name: Capacity
  description: 1 command acting on Capacity.
- name: Certificate
  description: 6 commands acting on Certificate.
- name: CiscoAsa1000vResource
  description: 3 commands acting on CiscoAsa1000vResource.
- name: CiscoNexusVSM
  description: 4 commands acting on CiscoNexusVSM.
- name: CiscoVnmcResource
  description: 3 commands acting on CiscoVnmcResource.
- name: CleanVMReservation
  description: 1 command acting on CleanVMReservation.
- name: CloudIdentifier
  description: 1 command acting on CloudIdentifier.
- name: CloudToUseObjectStore
  description: 1 command acting on CloudToUseObjectStore.
- name: CloudianIsEnabled
  description: 1 command acting on CloudianIsEnabled.
- name: Cluster
  description: 11 commands acting on Cluster.
- name: ClusterDrsPlan
  description: 2 commands acting on ClusterDrsPlan.
- name: ClustersMetric
  description: 1 command acting on ClustersMetric.
- name: CniConfiguration
  description: 3 commands acting on CniConfiguration.
- name: Condition
  description: 4 commands acting on Condition.
- name: ConfigTungstenFabricService
  description: 1 command acting on ConfigTungstenFabricService.
- name: Configuration
  description: 3 commands acting on Configuration.
- name: ConfigurationGroup
  description: 1 command acting on ConfigurationGroup.
- name: ConsoleEndpoint
  description: 1 command acting on ConsoleEndpoint.
- name: ConsoleSession
  description: 1 command acting on ConsoleSession.
- name: Counter
  description: 3 commands acting on Counter.
- name: CustomAction
  description: 5 commands acting on CustomAction.
- name: DbMetric
  description: 1 command acting on DbMetric.
- name: DeclareHostAsDegraded
  description: 1 command acting on DeclareHostAsDegraded.
- name: DedicatedGuestVlanRange
  description: 2 commands acting on DedicatedGuestVlanRange.
- name: DedicatedHost
  description: 2 commands acting on DedicatedHost.
- name: DedicatedPod
  description: 2 commands acting on DedicatedPod.
- name: DedicatedZone
  description: 2 commands acting on DedicatedZone.
- name: DeploymentPlanner
  description: 1 command acting on DeploymentPlanner.
- name: DetailOption
  description: 1 command acting on DetailOption.
- name: Diagnostic
  description: 1 command acting on Diagnostic.
- name: DiagnosticsData
  description: 1 command acting on DiagnosticsData.
- name: DisableHAForHost
  description: 1 command acting on DisableHAForHost.
- name: DisableHAForZone
  description: 1 command acting on DisableHAForZone.
- name: DisableOutOfBandManagementForHost
  description: 1 command acting on DisableOutOfBandManagementForHost.
- name: DisableOutOfBandManagementForZone
  description: 1 command acting on DisableOutOfBandManagementForZone.
- name: DisableRole
  description: 1 command acting on DisableRole.
- name: DisableStaticNat
  description: 1 command acting on DisableStaticNat.
- name: DisableUser
  description: 1 command acting on DisableUser.
- name: DiskOffering
  description: 6 commands acting on DiskOffering.
- name: DnsProvider
  description: 1 command acting on DnsProvider.
- name: DnsRecord
  description: 3 commands acting on DnsRecord.
- name: DnsServer
  description: 4 commands acting on DnsServer.
- name: DnsZone
  description: 4 commands acting on DnsZone.
- name: Domain
  description: 5 commands acting on Domain.
- name: DomainChildren
  description: 1 command acting on DomainChildren.
- name: DomainToLdap
  description: 1 command acting on DomainToLdap.
- name: EgressFirewallRule
  description: 4 commands acting on EgressFirewallRule.
- name: ElastistorInterface
  description: 1 command acting on ElastistorInterface.
- name: ElastistorPool
  description: 1 command acting on ElastistorPool.
- name: Event
  description: 3 commands acting on Event.
- name: EventType
  description: 1 command acting on EventType.
- name: ExecuteClusterDrsPlan
  description: 1 command acting on ExecuteClusterDrsPlan.
- name: ExecuteWebhookDelivery
  description: 1 command acting on ExecuteWebhookDelivery.
- name: Extension
  description: 7 commands acting on Extension.
- name: FinishBackupChain
  description: 1 command acting on FinishBackupChain.
- name: FirewallRule
  description: 4 commands acting on FirewallRule.
- name: ForMaintenance
  description: 1 command acting on ForMaintenance.
- name: ForShutdown
  description: 1 command acting on ForShutdown.
- name: GlobalLoadBalancerRule
  description: 6 commands acting on GlobalLoadBalancerRule.
- name: GloboDnsHost
  description: 1 command acting on GloboDnsHost.
- name: GpuCard
  description: 4 commands acting on GpuCard.
- name: GpuDevice
  description: 7 commands acting on GpuDevice.
- name: GuestNetworkIpv6Prefix
  description: 2 commands acting on GuestNetworkIpv6Prefix.
- name: GuestNetworkIpv6Prefixe
  description: 1 command acting on GuestNetworkIpv6Prefixe.
- name: GuestO
  description: 3 commands acting on GuestO.
- name: GuestOsMapping
  description: 4 commands acting on GuestOsMapping.
- name: GuestVlan
  description: 1 command acting on GuestVlan.
- name: GuestVlanRange
  description: 1 command acting on GuestVlanRange.
- name: GuiTheme
  description: 4 commands acting on GuiTheme.
- name: HAForHost
  description: 2 commands acting on HAForHost.
- name: HAForZone
  description: 1 command acting on HAForZone.
- name: HSMProfile
  description: 4 commands acting on HSMProfile.
- name: Host
  description: 6 commands acting on Host.
- name: HostAsDegraded
  description: 1 command acting on HostAsDegraded.
- name: HostForMaintenance
  description: 1 command acting on HostForMaintenance.
- name: HostHAProvider
  description: 1 command acting on HostHAProvider.
- name: HostHAResource
  description: 1 command acting on HostHAResource.
- name: HostMaintenance
  description: 1 command acting on HostMaintenance.
- name: HostPassword
  description: 1 command acting on HostPassword.
- name: HostReservation
  description: 1 command acting on HostReservation.
- name: HostTag
  description: 1 command acting on HostTag.
- name: HostsForMigration
  description: 1 command acting on HostsForMigration.
- name: HostsMetric
  description: 1 command acting on HostsMetric.
- name: Hypervisor
  description: 1 command acting on Hypervisor.
- name: HypervisorCapability
  description: 2 commands acting on HypervisorCapability.
- name: HypervisorGuestOsName
  description: 1 command acting on HypervisorGuestOsName.
- name: ImageStore
  description: 4 commands acting on ImageStore.
- name: ImageStoreObject
  description: 2 commands acting on ImageStoreObject.
- name: ImageStoreS3
  description: 1 command acting on ImageStoreS3.
- name: ImportVmTask
  description: 1 command acting on ImportVmTask.
- name: Infrastructure
  description: 1 command acting on Infrastructure.
- name: InstanceGroup
  description: 4 commands acting on InstanceGroup.
- name: InternalLoadBalancerElement
  description: 3 commands acting on InternalLoadBalancerElement.
- name: InternalLoadBalancerVM
  description: 3 commands acting on InternalLoadBalancerVM.
- name: IpAddress
  description: 8 commands acting on IpAddress.
- name: IpForwardingRule
  description: 3 commands acting on IpForwardingRule.
- name: IpFromNic
  description: 1 command acting on IpFromNic.
- name: IpToNic
  description: 1 command acting on IpToNic.
- name: Ipv4SubnetForZone
  description: 5 commands acting on Ipv4SubnetForZone.
- name: Ipv4SubnetsForZone
  description: 1 command acting on Ipv4SubnetsForZone.
- name: Ipv6FirewallRule
  description: 4 commands acting on Ipv6FirewallRule.
- name: Iso
  description: 8 commands acting on Iso.
- name: IsoPermission
  description: 2 commands acting on IsoPermission.
- name: KMSKey
  description: 5 commands acting on KMSKey.
- name: KubernetesCluster
  description: 11 commands acting on KubernetesCluster.
- name: KubernetesClusterConfig
  description: 1 command acting on KubernetesClusterConfig.
- name: KubernetesSupportedVersion
  description: 5 commands acting on KubernetesSupportedVersion.
- name: LBHealthCheckPolicy
  description: 4 commands acting on LBHealthCheckPolicy.
- name: LBStickinessPolicy
  description: 4 commands acting on LBStickinessPolicy.
- name: LdapConfig
  description: 1 command acting on LdapConfig.
- name: LdapConfiguration
  description: 3 commands acting on LdapConfiguration.
- name: LdapRemove
  description: 1 command acting on LdapRemove.
- name: LdapUser
  description: 2 commands acting on LdapUser.
- name: LoadBalancer
  description: 6 commands acting on LoadBalancer.
- name: LoadBalancerRule
  description: 6 commands acting on LoadBalancerRule.
- name: LoadBalancerRuleInstance
  description: 1 command acting on LoadBalancerRuleInstance.
- name: Login
  description: 1 command acting on Login.
- name: Logout
  description: 1 command acting on Logout.
- name: Maintenance
  description: 1 command acting on Maintenance.
- name: ManagementNetworkIpRange
  description: 2 commands acting on ManagementNetworkIpRange.
- name: ManagementServer
  description: 2 commands acting on ManagementServer.
- name: ManagementServersMetric
  description: 1 command acting on ManagementServersMetric.
- name: NetScalerVpx
  description: 1 command acting on NetScalerVpx.
- name: NetscalerControlCenter
  description: 3 commands acting on NetscalerControlCenter.
- name: NetscalerLoadBalancer
  description: 4 commands acting on NetscalerLoadBalancer.
- name: NetscalerServicePackage
  description: 1 command acting on NetscalerServicePackage.
- name: NetscalerVpx
  description: 1 command acting on NetscalerVpx.
- name: Network
  description: 19 commands acting on Network.
- name: NetworkACL
  description: 4 commands acting on NetworkACL.
- name: NetworkACLItem
  description: 1 command acting on NetworkACLItem.
- name: NetworkACLList
  description: 5 commands acting on NetworkACLList.
- name: NetworkAclItem
  description: 1 command acting on NetworkAclItem.
- name: NetworkDevice
  description: 3 commands acting on NetworkDevice.
- name: NetworkIsolationMethod
  description: 1 command acting on NetworkIsolationMethod.
- name: NetworkOffering
  description: 5 commands acting on NetworkOffering.
- name: NetworkPermission
  description: 4 commands acting on NetworkPermission.
- name: NetworkProtocol
  description: 1 command acting on NetworkProtocol.
- name: NetworkServiceProvider
  description: 4 commands acting on NetworkServiceProvider.
- name: Nic
  description: 1 command acting on Nic.
- name: NiciraNvpDevice
  description: 3 commands acting on NiciraNvpDevice.
- name: NotifyBaremetalProvisionDone
  description: 1 command acting on NotifyBaremetalProvisionDone.
- name: OAuthCodeAndGetUser
  description: 1 command acting on OAuthCodeAndGetUser.
- name: OauthProvider
  description: 4 commands acting on OauthProvider.
- name: Oauthlogin
  description: 1 command acting on Oauthlogin.
- name: ObjectStoragePool
  description: 4 commands acting on ObjectStoragePool.
- name: OpenDaylightController
  description: 3 commands acting on OpenDaylightController.
- name: OsCategory
  description: 4 commands acting on OsCategory.
- name: OsType
  description: 1 command acting on OsType.
- name: OutOfBandManagement
  description: 1 command acting on OutOfBandManagement.
- name: OutOfBandManagementForHost
  description: 1 command acting on OutOfBandManagementForHost.
- name: OutOfBandManagementForZone
  description: 1 command acting on OutOfBandManagementForZone.
- name: OutOfBandManagementPassword
  description: 1 command acting on OutOfBandManagementPassword.
- name: OutOfBandManagementPowerAction
  description: 1 command acting on OutOfBandManagementPowerAction.
- name: OvsElement
  description: 2 commands acting on OvsElement.
- name: PaloAltoFirewall
  description: 4 commands acting on PaloAltoFirewall.
- name: PhysicalNetwork
  description: 4 commands acting on PhysicalNetwork.
- name: Pod
  description: 5 commands acting on Pod.
- name: PodManagementNetworkIpRange
  description: 1 command acting on PodManagementNetworkIpRange.
- name: PortForwardingRule
  description: 4 commands acting on PortForwardingRule.
- name: PortableIpRange
  description: 3 commands acting on PortableIpRange.
- name: PrivateGateway
  description: 3 commands acting on PrivateGateway.
- name: Project
  description: 10 commands acting on Project.
- name: ProjectInvitation
  description: 3 commands acting on ProjectInvitation.
- name: ProjectRole
  description: 4 commands acting on ProjectRole.
- name: ProjectRolePermission
  description: 4 commands acting on ProjectRolePermission.
- name: PublicIpRange
  description: 2 commands acting on PublicIpRange.
- name: PurgeExpungedResource
  description: 1 command acting on PurgeExpungedResource.
- name: QuarantinedIp
  description: 3 commands acting on QuarantinedIp.
- name: QuotaIsEnabled
  description: 1 command acting on QuotaIsEnabled.
- name: RawUsageRecord
  description: 1 command acting on RawUsageRecord.
- name: ReadyForShutdown
  description: 1 command acting on ReadyForShutdown.
- name: Region
  description: 4 commands acting on Region.
- name: RegisteredServicePackage
  description: 1 command acting on RegisteredServicePackage.
- name: RemoteAccessVpn
  description: 4 commands acting on RemoteAccessVpn.
- name: ResourceCount
  description: 1 command acting on ResourceCount.
- name: ResourceDetail
  description: 3 commands acting on ResourceDetail.
- name: ResourceIcon
  description: 3 commands acting on ResourceIcon.
- name: ResourceLimit
  description: 2 commands acting on ResourceLimit.
- name: ResourceSchedule
  description: 4 commands acting on ResourceSchedule.
- name: ResourceToAnotherSecondaryStorage
  description: 1 command acting on ResourceToAnotherSecondaryStorage.
- name: Role
  description: 6 commands acting on Role.
- name: RolePermission
  description: 4 commands acting on RolePermission.
- name: RollingMaintenance
  description: 1 command acting on RollingMaintenance.
- name: Router
  description: 8 commands acting on Router.
- name: RouterHealthCheckResult
  description: 1 command acting on RouterHealthCheckResult.
- name: RoutingFirewallRule
  description: 4 commands acting on RoutingFirewallRule.
- name: SSHKeyPair
  description: 4 commands acting on SSHKeyPair.
- name: SearchLdap
  description: 1 command acting on SearchLdap.
- name: SecondaryStagingStore
  description: 3 commands acting on SecondaryStagingStore.
- name: SecondaryStorage
  description: 1 command acting on SecondaryStorage.
- name: SecondaryStorageData
  description: 1 command acting on SecondaryStorageData.
- name: SecondaryStorageSelector
  description: 4 commands acting on SecondaryStorageSelector.
- name: SecurityGroup
  description: 4 commands acting on SecurityGroup.
- name: SecurityGroupEgress
  description: 2 commands acting on SecurityGroupEgress.
- name: SecurityGroupIngress
  description: 2 commands acting on SecurityGroupIngress.
- name: ServiceInstance
  description: 1 command acting on ServiceInstance.
- name: ServiceOffering
  description: 6 commands acting on ServiceOffering.
- name: ServicePackageOffering
  description: 1 command acting on ServicePackageOffering.
- name: SetupUserTwoFactorAuthentication
  description: 1 command acting on SetupUserTwoFactorAuthentication.
- name: SharedFileSystem
  description: 9 commands acting on SharedFileSystem.
- name: SharedFileSystemProvider
  description: 1 command acting on SharedFileSystemProvider.
- name: Shutdown
  description: 1 command acting on Shutdown.
- name: SiocInfo
  description: 1 command acting on SiocInfo.
- name: Snapshot
  description: 7 commands acting on Snapshot.
- name: SnapshotPolicy
  description: 4 commands acting on SnapshotPolicy.
- name: SolidFireAccountId
  description: 1 command acting on SolidFireAccountId.
- name: SolidFireVolumeAccessGroupId
  description: 1 command acting on SolidFireVolumeAccessGroupId.
- name: SolidFireVolumeSize
  description: 1 command acting on SolidFireVolumeSize.
- name: SslCert
  description: 3 commands acting on SslCert.
- name: StaticNat
  description: 1 command acting on StaticNat.
- name: StaticRoute
  description: 3 commands acting on StaticRoute.
- name: StorageAccess
  description: 1 command acting on StorageAccess.
- name: StorageAccessGroup
  description: 1 command acting on StorageAccessGroup.
- name: StorageCapability
  description: 1 command acting on StorageCapability.
- name: StorageMaintenance
  description: 2 commands acting on StorageMaintenance.
- name: StorageNetworkIpRange
  description: 4 commands acting on StorageNetworkIpRange.
- name: StoragePool
  description: 5 commands acting on StoragePool.
- name: StoragePoolObject
  description: 1 command acting on StoragePoolObject.
- name: StoragePoolScope
  description: 1 command acting on StoragePoolScope.
- name: StoragePoolsForMigration
  description: 1 command acting on StoragePoolsForMigration.
- name: StoragePoolsMetric
  description: 1 command acting on StoragePoolsMetric.
- name: StorageProvider
  description: 1 command acting on StorageProvider.
- name: StorageTag
  description: 1 command acting on StorageTag.
- name: StratosphereSsp
  description: 2 commands acting on StratosphereSsp.
- name: SupportedNetworkService
  description: 1 command acting on SupportedNetworkService.
- name: Swift
  description: 2 commands acting on Swift.
- name: SynchronizeTungstenFabricData
  description: 1 command acting on SynchronizeTungstenFabricData.
- name: SystemVm
  description: 9 commands acting on SystemVm.
- name: SystemVmsUsageHistory
  description: 1 command acting on SystemVmsUsageHistory.
- name: Tag
  description: 3 commands acting on Tag.
- name: Template
  description: 11 commands acting on Template.
- name: TemplateDirectDownloadCertificate
  description: 4 commands acting on TemplateDirectDownloadCertificate.
- name: TemplatePermission
  description: 2 commands acting on TemplatePermission.
- name: TrafficMonitor
  description: 3 commands acting on TrafficMonitor.
- name: TrafficType
  description: 4 commands acting on TrafficType.
- name: TrafficTypeImplementor
  description: 1 command acting on TrafficTypeImplementor.
- name: TriggerShutdown
  description: 1 command acting on TriggerShutdown.
- name: TungstenFabricAddressGroup
  description: 3 commands acting on TungstenFabricAddressGroup.
- name: TungstenFabricApplicationPolicySet
  description: 3 commands acting on TungstenFabricApplicationPolicySet.
- name: TungstenFabricFirewallPolicy
  description: 3 commands acting on TungstenFabricFirewallPolicy.
- name: TungstenFabricFirewallRule
  description: 3 commands acting on TungstenFabricFirewallRule.
- name: TungstenFabricLBHealthMonitor
  description: 2 commands acting on TungstenFabricLBHealthMonitor.
- name: TungstenFabricLogicalRouter
  description: 3 commands acting on TungstenFabricLogicalRouter.
- name: TungstenFabricNic
  description: 1 command acting on TungstenFabricNic.
- name: TungstenFabricPolicy
  description: 5 commands acting on TungstenFabricPolicy.
- name: TungstenFabricPolicyRule
  description: 3 commands acting on TungstenFabricPolicyRule.
- name: TungstenFabricProvider
  description: 2 commands acting on TungstenFabricProvider.
- name: TungstenFabricServiceGroup
  description: 3 commands acting on TungstenFabricServiceGroup.
- name: TungstenFabricTag
  description: 5 commands acting on TungstenFabricTag.
- name: TungstenFabricTagType
  description: 3 commands acting on TungstenFabricTagType.
- name: TungstenFabricVm
  description: 1 command acting on TungstenFabricVm.
- name: UcsBlade
  description: 1 command acting on UcsBlade.
- name: UcsManager
  description: 3 commands acting on UcsManager.
- name: UcsProfile
  description: 1 command acting on UcsProfile.
- name: UcsProfileToBlade
  description: 1 command acting on UcsProfileToBlade.
- name: UnlinkDomainFromLdap
  description: 1 command acting on UnlinkDomainFromLdap.
- name: UnmanagedInstance
  description: 2 commands acting on UnmanagedInstance.
- name: UploadParamsForIso
  description: 1 command acting on UploadParamsForIso.
- name: UsageRecord
  description: 2 commands acting on UsageRecord.
- name: UsageServerMetric
  description: 1 command acting on UsageServerMetric.
- name: UsageType
  description: 1 command acting on UsageType.
- name: User
  description: 8 commands acting on User.
- name: UserData
  description: 4 commands acting on UserData.
- name: UserKey
  description: 4 commands acting on UserKey.
- name: UserKeyRule
  description: 1 command acting on UserKeyRule.
- name: UserTwoFactorAuthenticationCode
  description: 1 command acting on UserTwoFactorAuthenticationCode.
- name: UserTwoFactorAuthenticatorProvider
  description: 1 command acting on UserTwoFactorAuthenticatorProvider.
- name: VMPassword
  description: 1 command acting on VMPassword.
- name: VMSchedule
  description: 4 commands acting on VMSchedule.
- name: VMSnapshot
  description: 5 commands acting on VMSnapshot.
- name: VPC
  description: 6 commands acting on VPC.
- name: VPCOffering
  description: 5 commands acting on VPCOffering.
- name: ValidationScreenshot
  description: 1 command acting on ValidationScreenshot.
- name: VgpuProfile
  description: 4 commands acting on VgpuProfile.
- name: VirtualMachine
  description: 21 commands acting on VirtualMachine.
- name: VirtualMachinesMetric
  description: 1 command acting on VirtualMachinesMetric.
- name: VirtualMachinesUsageHistory
  description: 1 command acting on VirtualMachinesUsageHistory.
- name: VirtualRouterElement
  description: 3 commands acting on VirtualRouterElement.
- name: VlanIpRange
  description: 4 commands acting on VlanIpRange.
- name: Vm
  description: 1 command acting on Vm.
- name: VmNic
  description: 1 command acting on VmNic.
- name: VmNicIp
  description: 1 command acting on VmNicIp.
- name: VmsForImport
  description: 1 command acting on VmsForImport.
- name: VmwareDc
  description: 4 commands acting on VmwareDc.
- name: VmwareDcVm
  description: 1 command acting on VmwareDcVm.
- name: VnfAppliance
  description: 2 commands acting on VnfAppliance.
- name: VnfTemplate
  description: 4 commands acting on VnfTemplate.
- name: Volume
  description: 21 commands acting on Volume.
- name: VolumeFromBackupAndAttachToVM
  description: 1 command acting on VolumeFromBackupAndAttachToVM.
- name: VolumeSnapshotDetail
  description: 1 command acting on VolumeSnapshotDetail.
- name: VolumeiScsiName
  description: 1 command acting on VolumeiScsiName.
- name: VolumesForImport
  description: 1 command acting on VolumesForImport.
- name: VolumesMetric
  description: 1 command acting on VolumesMetric.
- name: VolumesToKMS
  description: 1 command acting on VolumesToKMS.
- name: VolumesUsageHistory
  description: 1 command acting on VolumesUsageHistory.
- name: VpnConnection
  description: 5 commands acting on VpnConnection.
- name: VpnCustomerGateway
  description: 4 commands acting on VpnCustomerGateway.
- name: VpnGateway
  description: 4 commands acting on VpnGateway.
- name: VpnUser
  description: 3 commands acting on VpnUser.
- name: VsphereStoragePolicy
  description: 2 commands acting on VsphereStoragePolicy.
- name: VsphereStoragePolicyCompatiblePool
  description: 1 command acting on VsphereStoragePolicyCompatiblePool.
- name: Webhook
  description: 4 commands acting on Webhook.
- name: WebhookDelivery
  description: 2 commands acting on WebhookDelivery.
- name: WebhookFilter
  description: 3 commands acting on WebhookFilter.
- name: Zone
  description: 5 commands acting on Zone.
- name: ZonesMetric
  description: 1 command acting on ZonesMetric.
paths:
  /acquirePodIpAddress:
    get:
      operationId: acquirePodIpAddress
      summary: Allocates IP addresses in respective Pod of a Zone
      tags:
      - IpAddress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: acquirePodIpAddress
          default: acquirePodIpAddress
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The ID of the zone
        required: true
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: podid
        in: query
        description: Pod ID
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `acquirePodIpAddress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  acquirepodipaddressresponse:
                    oneOf:
                    - &id001
                      $ref: '#/components/schemas/AcquirePodIpAddress'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id001
                        - type: array
                          items: *id001
                required:
                - acquirepodipaddressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  acquirepodipaddressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - acquirepodipaddressresponse
      x-cloudstack-command: acquirePodIpAddress
      x-cloudstack-async: false
  /activateProject:
    get:
      operationId: activateProject
      summary: Activates a project
      description: |-
        Activates a project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: activateProject
          default: activateProject
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the project to be modified
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
      responses:
        '200':
          description: Successful invocation of `activateProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  activateprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - activateprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  activateprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - activateprojectresponse
      x-cloudstack-command: activateProject
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - createProject
      x-cloudstack-jobresult-schema: '#/components/schemas/Project'
  /addAccountToProject:
    get:
      operationId: addAccountToProject
      summary: Adds Account to a project
      description: |-
        Adds Account to a project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addAccountToProject
          default: addAccountToProject
      - $ref: '#/components/parameters/response'
      - name: projectid
        in: query
        description: ID of the project to add the Account to
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: account
        in: query
        description: Name of the Account to be added to the project
        schema:
          type: string
          maxLength: 255
      - name: email
        in: query
        description: Email to which invitation to the project is going to be sent
        schema:
          type: string
          maxLength: 255
      - name: projectroleid
        in: query
        description: ID of the project role
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectRoles
        - updateProjectRole
      - name: roletype
        in: query
        description: 'Project role type to be assigned to the User - Admin/Regular; default: Regular'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addAccountToProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addaccounttoprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addaccounttoprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addaccounttoprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addaccounttoprojectresponse
      x-cloudstack-command: addAccountToProject
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /addAnnotation:
    get:
      operationId: addAnnotation
      summary: Add an annotation.
      tags:
      - Annotation
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addAnnotation
          default: addAnnotation
      - $ref: '#/components/parameters/response'
      - name: adminsonly
        in: query
        description: The annotation is visible for admins only
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      - name: annotation
        in: query
        description: The annotation text
        schema:
          type: string
          maxLength: 255
      - name: entityid
        in: query
        description: The ID of the entity to annotate
        schema:
          type: string
          maxLength: 255
      - name: entitytype
        in: query
        description: The following entity types are allowed VM, VOLUME, SNAPSHOT, VM_SNAPSHOT, INSTANCE_GROUP, SSH_KEYPAIR, USER_DATA, NETWORK, VPC, PUBLIC_IP_ADDRESS, VPN_CUSTOMER_GATEWAY, TEMPLATE, ISO, KUBERNETES_CLUSTER, SERVICE_OFFERING, DISK_OFFERING, NETWORK_OFFERING, ZONE, POD, CLUSTER, HOST, DOMAIN, PRIMARY_STORAGE, SECONDARY_STORAGE, VR, SYSTEM_VM, AUTOSCALE_VM_GROUP, MANAGEMENT_SERVER
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addAnnotation`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addannotationresponse:
                    oneOf:
                    - &id002
                      $ref: '#/components/schemas/Annotation'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id002
                        - type: array
                          items: *id002
                required:
                - addannotationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addannotationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addannotationresponse
      x-cloudstack-command: addAnnotation
      x-cloudstack-async: false
      x-cloudstack-since: '4.11'
  /addBackupRepository:
    get:
      operationId: addBackupRepository
      summary: Adds a backup repository to store NAS backups
      tags:
      - BackupRepository
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addBackupRepository
          default: addBackupRepository
      - $ref: '#/components/parameters/response'
      - name: address
        in: query
        description: address of the backup repository
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: name of the backup repository
        required: true
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: 'type of the backup repository storage. Supported values: nfs, cephfs, cifs'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: ID of the zone where the backup repository is to be added for taking backups
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: capacitybytes
        in: query
        description: capacity of this backup repository
        schema:
          type: integer
          format: int64
      - name: crosszoneinstancecreation
        in: query
        description: backups on this repository can be used to create Instances on all Zones
        schema:
          type: boolean
        x-cloudstack-since: 4.22.0
      - name: mountopts
        in: query
        description: shared storage mount options
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: backup repository provider
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addBackupRepository`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbackuprepositoryresponse:
                    oneOf:
                    - &id003
                      $ref: '#/components/schemas/BackupRepository'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id003
                        - type: array
                          items: *id003
                required:
                - addbackuprepositoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbackuprepositoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addbackuprepositoryresponse
      x-cloudstack-command: addBackupRepository
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /addBaremetalDhcp:
    get:
      operationId: addBaremetalDhcp
      summary: Adds a baremetal DHCP server
      description: |-
        Adds a baremetal DHCP server

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BaremetalDhcp
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addBaremetalDhcp
          default: addBaremetalDhcp
      - $ref: '#/components/parameters/response'
      - name: dhcpservertype
        in: query
        description: Type of dhcp device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: Credentials to reach external dhcp device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: url
        in: query
        description: URL of the external dhcp appliance.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Credentials to reach external dhcp device
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addBaremetalDhcp`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetaldhcpresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addbaremetaldhcpresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetaldhcpresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addbaremetaldhcpresponse
      x-cloudstack-command: addBaremetalDhcp
      x-cloudstack-async: true
      x-cloudstack-related:
      - listBaremetalDhcp
      x-cloudstack-jobresult-schema: '#/components/schemas/BaremetalDhcp'
  /addBaremetalHost:
    get:
      operationId: addBaremetalHost
      summary: Add a baremetal host
      tags:
      - BaremetalHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addBaremetalHost
          default: addBaremetalHost
      - $ref: '#/components/parameters/response'
      - name: hypervisor
        in: query
        description: Hypervisor type of the host
        required: true
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: The Pod ID for the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
      - name: url
        in: query
        description: 'The host URL, optionally add ssh port (format: ''host:port'') for KVM hosts, otherwise falls back to the port defined at the config ''kvm.host.discovery.ssh.port'''
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID for the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: allocationstate
        in: query
        description: Allocation state of this Host for allocation of new resources
        schema:
          type: string
          maxLength: 255
      - name: clusterid
        in: query
        description: The cluster ID for the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: clustername
        in: query
        description: The cluster name for the host
        schema:
          type: string
          maxLength: 255
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: hosttags
        in: query
        description: List of tags to be added to the host. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: ipaddress
        in: query
        description: IP address intentionally allocated to this host after provisioning
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: The password for the host; required to be passed for hypervisors other than VMWare
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroups
        in: query
        description: comma separated list of storage access groups for the host. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
      - name: username
        in: query
        description: The username for the host; required to be passed for hypervisors other than VMWare
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addBaremetalHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetalhostresponse:
                    oneOf:
                    - &id004
                      $ref: '#/components/schemas/Host'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id004
                        - type: array
                          items: *id004
                required:
                - addbaremetalhostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetalhostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addbaremetalhostresponse
      x-cloudstack-command: addBaremetalHost
      x-cloudstack-async: false
      x-cloudstack-related:
      - declareHostAsDegraded
      - listHosts
      - reconnectHost
  /addBaremetalPxeKickStartServer:
    get:
      operationId: addBaremetalPxeKickStartServer
      summary: Add a baremetal PXE server
      description: |-
        Add a baremetal PXE server

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BaremetalPxeKickStartServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addBaremetalPxeKickStartServer
          default: addBaremetalPxeKickStartServer
      - $ref: '#/components/parameters/response'
      - name: password
        in: query
        description: Credentials to reach external pxe device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: pxeservertype
        in: query
        description: Type of pxe device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: tftpdir
        in: query
        description: TFTP root directory of the PXE server
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: URL of the external pxe device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Credentials to reach external pxe device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: Pod Id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      responses:
        '200':
          description: Successful invocation of `addBaremetalPxeKickStartServer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetalpxekickstartserverresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addbaremetalpxekickstartserverresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetalpxekickstartserverresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addbaremetalpxekickstartserverresponse
      x-cloudstack-command: addBaremetalPxeKickStartServer
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/BaremetalPxeKickStartServer'
  /addBaremetalPxePingServer:
    get:
      operationId: addBaremetalPxePingServer
      summary: Add a baremetal ping PXE server
      description: |-
        Add a baremetal ping PXE server

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BaremetalPxePingServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addBaremetalPxePingServer
          default: addBaremetalPxePingServer
      - $ref: '#/components/parameters/response'
      - name: password
        in: query
        description: Credentials to reach external pxe device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: pingdir
        in: query
        description: Root directory on PING storage server
        required: true
        schema:
          type: string
          maxLength: 255
      - name: pingstorageserverip
        in: query
        description: PING storage server IP
        required: true
        schema:
          type: string
          maxLength: 255
      - name: pxeservertype
        in: query
        description: Type of pxe device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: tftpdir
        in: query
        description: TFTP root directory of PXE server
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: URL of the external pxe device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Credentials to reach external pxe device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: pingcifspassword
        in: query
        description: Password of PING storage server
        schema:
          type: string
          maxLength: 255
      - name: pingcifsusername
        in: query
        description: Username of PING storage server
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: Pod Id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      responses:
        '200':
          description: Successful invocation of `addBaremetalPxePingServer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetalpxepingserverresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addbaremetalpxepingserverresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetalpxepingserverresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addbaremetalpxepingserverresponse
      x-cloudstack-command: addBaremetalPxePingServer
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/BaremetalPxePingServer'
  /addBaremetalRct:
    get:
      operationId: addBaremetalRct
      summary: Adds baremetal rack configuration text
      description: |-
        Adds baremetal rack configuration text

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BaremetalRct
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addBaremetalRct
          default: addBaremetalRct
      - $ref: '#/components/parameters/response'
      - name: baremetalrcturl
        in: query
        description: HTTP URL to baremetal RCT configuration
        required: true
        schema:
          type: string
          x-cloudstack-type: object
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addBaremetalRct`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetalrctresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addbaremetalrctresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbaremetalrctresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addbaremetalrctresponse
      x-cloudstack-command: addBaremetalRct
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/BaremetalRct'
  /addBigSwitchBcfDevice:
    get:
      operationId: addBigSwitchBcfDevice
      summary: Adds a BigSwitch BCF Controller device
      description: |-
        Adds a BigSwitch BCF Controller device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BigSwitchBcfDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addBigSwitchBcfDevice
          default: addBigSwitchBcfDevice
      - $ref: '#/components/parameters/response'
      - name: hostname
        in: query
        description: Hostname of ip address of the BigSwitch BCF Controller.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: nat
        in: query
        description: NAT support of the BigSwitch BCF Controller.
        required: true
        schema:
          type: boolean
      - name: password
        in: query
        description: Password of the BigSwitch BCF Controller.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: username
        in: query
        description: Username of the BigSwitch BCF Controller.
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addBigSwitchBcfDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbigswitchbcfdeviceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addbigswitchbcfdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbigswitchbcfdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addbigswitchbcfdeviceresponse
      x-cloudstack-command: addBigSwitchBcfDevice
      x-cloudstack-async: true
      x-cloudstack-since: 4.6.0
      x-cloudstack-related:
      - listBigSwitchBcfDevices
      x-cloudstack-jobresult-schema: '#/components/schemas/BigSwitchBcfDevice'
  /addBrocadeVcsDevice:
    get:
      operationId: addBrocadeVcsDevice
      summary: Adds a Brocade VCS Switch
      description: |-
        Adds a Brocade VCS Switch

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BrocadeVcsDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addBrocadeVcsDevice
          default: addBrocadeVcsDevice
      - $ref: '#/components/parameters/response'
      - name: hostname
        in: query
        description: Hostname of IP address of the Brocade VCS Switch.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: Credentials to access the Brocade VCS Switch API
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: username
        in: query
        description: Credentials to access the Brocade VCS Switch API
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addBrocadeVcsDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbrocadevcsdeviceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addbrocadevcsdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addbrocadevcsdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addbrocadevcsdeviceresponse
      x-cloudstack-command: addBrocadeVcsDevice
      x-cloudstack-async: true
      x-cloudstack-related:
      - listBrocadeVcsDevices
      x-cloudstack-jobresult-schema: '#/components/schemas/BrocadeVcsDevice'
  /addCiscoAsa1000vResource:
    get:
      operationId: addCiscoAsa1000vResource
      summary: Adds a Cisco Asa 1000v appliance
      tags:
      - CiscoAsa1000vResource
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addCiscoAsa1000vResource
          default: addCiscoAsa1000vResource
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: The Cluster ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
      - name: hostname
        in: query
        description: Hostname or ip address of the Cisco ASA 1000v appliance.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: insideportprofile
        in: query
        description: Nexus port profile associated with inside interface of ASA 1000v
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addCiscoAsa1000vResource`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addciscoasa1000vresourceresponse:
                    oneOf:
                    - &id005
                      $ref: '#/components/schemas/CiscoAsa1000vResource'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id005
                        - type: array
                          items: *id005
                required:
                - addciscoasa1000vresourceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addciscoasa1000vresourceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addciscoasa1000vresourceresponse
      x-cloudstack-command: addCiscoAsa1000vResource
      x-cloudstack-async: false
  /addCiscoVnmcResource:
    get:
      operationId: addCiscoVnmcResource
      summary: Adds a Cisco Vnmc Controller
      tags:
      - CiscoVnmcResource
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addCiscoVnmcResource
          default: addCiscoVnmcResource
      - $ref: '#/components/parameters/response'
      - name: hostname
        in: query
        description: Hostname or ip address of the Cisco VNMC Controller.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: Credentials to access the Cisco VNMC Controller API
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: username
        in: query
        description: Credentials to access the Cisco VNMC Controller API
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addCiscoVnmcResource`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addciscovnmcresourceresponse:
                    oneOf:
                    - &id006
                      $ref: '#/components/schemas/CiscoAsa1000vResource'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id006
                        - type: array
                          items: *id006
                required:
                - addciscovnmcresourceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addciscovnmcresourceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addciscovnmcresourceresponse
      x-cloudstack-command: addCiscoVnmcResource
      x-cloudstack-async: false
      x-cloudstack-related:
      - listCiscoVnmcResources
  /addCluster:
    get:
      operationId: addCluster
      summary: Adds a new cluster
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addCluster
          default: addCluster
      - $ref: '#/components/parameters/response'
      - name: clustername
        in: query
        description: The cluster name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: clustertype
        in: query
        description: 'Type of the cluster: CloudManaged, ExternalManaged'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hypervisor
        in: query
        description: 'Hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: The Pod ID for the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: zoneid
        in: query
        description: The Zone ID for the cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: allocationstate
        in: query
        description: Allocation state of this cluster for allocation of new resources
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'The CPU arch of the cluster. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: extensionid
        in: query
        description: UUID of the extension
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listExtensions
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].<key>=<value>. Example: externaldetails[0].endpoint.url=https://example.com. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: guestvswitchname
        in: query
        description: Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.
        schema:
          type: string
          maxLength: 255
      - name: guestvswitchtype
        in: query
        description: Type of virtual switch used for guest traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)
        schema:
          type: string
          maxLength: 255
      - name: ovm3cluster
        in: query
        description: Ovm3 native OCFS2 clustering enabled for cluster
        schema:
          type: string
          maxLength: 255
      - name: ovm3pool
        in: query
        description: Ovm3 native pooling enabled for cluster
        schema:
          type: string
          maxLength: 255
      - name: ovm3vip
        in: query
        description: Ovm3 vip to use for pool (and cluster)
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: The password for the host
        schema:
          type: string
          maxLength: 255
      - name: publicvswitchname
        in: query
        description: Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.
        schema:
          type: string
          maxLength: 255
      - name: publicvswitchtype
        in: query
        description: Type of virtual switch used for public traffic in the cluster. Allowed values are, vmwaresvs (for VMware standard vSwitch) and vmwaredvs (for VMware distributed vSwitch)
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroups
        in: query
        description: comma separated list of storage access groups for the hosts in the cluster. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
      - name: url
        in: query
        description: The URL
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: The username for the cluster
        schema:
          type: string
          maxLength: 255
      - name: vsmipaddress
        in: query
        description: The IP address of the VSM associated with this cluster
        schema:
          type: string
          maxLength: 255
      - name: vsmpassword
        in: query
        description: The password for the VSM associated with this cluster
        schema:
          type: string
          maxLength: 255
      - name: vsmusername
        in: query
        description: The username for the VSM associated with this cluster
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addclusterresponse:
                    oneOf:
                    - &id007
                      $ref: '#/components/schemas/Cluster'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id007
                        - type: array
                          items: *id007
                required:
                - addclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addclusterresponse
      x-cloudstack-command: addCluster
      x-cloudstack-async: false
  /addCustomAction:
    get:
      operationId: addCustomAction
      summary: Add a custom action for an extension
      tags:
      - CustomAction
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addCustomAction
          default: addCustomAction
      - $ref: '#/components/parameters/response'
      - name: extensionid
        in: query
        description: The ID of the extension to associate the action with
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - deleteExtension
        - listExtensions
        - registerExtension
        - unregisterExtension
        - updateExtension
      - name: name
        in: query
        description: Name of the action
        required: true
        schema:
          type: string
          maxLength: 255
      - name: allowedroletypes
        in: query
        description: List of role types allowed for the action. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: description
        in: query
        description: Description of the action
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: enabled
        in: query
        description: Whether the action is enabled or not. Default is disabled.
        schema:
          type: boolean
      - name: errormessage
        in: query
        description: 'Error message that will be used on failure during execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Failed to complete {{actionName}} for {{resourceName}} with {{extensionName}}'
        schema:
          type: string
          maxLength: 255
      - name: parameters
        in: query
        description: 'Parameters mapping for the action using keys - name, type, required. ''name'' is mandatory. If ''type'' is not specified then STRING will be used. If ''required'' is not specified then false will be used. Example: parameters[0].name=xxx&parameters[0].type=BOOLEAN&parameters[0].required=true. Map parameter. CloudStack expects it index-encoded as `parameters[0].key=k&parameters[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: resourcetype
        in: query
        description: Resource type for which the action is available
        schema:
          type: string
          maxLength: 255
      - name: successmessage
        in: query
        description: 'Success message that will be used on successful execution of the action. Name of the action, extension, resource can be used as - actionName, extensionName, resourceName. Example: Successfully complete {{actionName}} for {{resourceName}} with {{extensionName}}'
        schema:
          type: string
          maxLength: 255
      - name: timeout
        in: query
        description: Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 seconds
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `addCustomAction`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addcustomactionresponse:
                    oneOf:
                    - &id008
                      $ref: '#/components/schemas/CustomAction'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id008
                        - type: array
                          items: *id008
                required:
                - addcustomactionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addcustomactionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addcustomactionresponse
      x-cloudstack-command: addCustomAction
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - listCustomActions
  /addDnsServer:
    get:
      operationId: addDnsServer
      summary: Adds a new external DNS server
      tags:
      - DnsServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addDnsServer
          default: addDnsServer
      - $ref: '#/components/parameters/response'
      - name: dnsapikey
        in: query
        description: API key or token for the DNS provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the DNS server
        required: true
        schema:
          type: string
          maxLength: 255
      - name: nameservers
        in: query
        description: Comma separated list of name servers; used to create NS records for the DNS Zone (for example, ns1.example.com, ns2.example.com). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: provider
        in: query
        description: Provider type (e.g., PowerDNS)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: API URL of the provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].pdnsServerId=localhost. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: dnsusername
        in: query
        description: Username or email associated with the DNS provider account (used for authentication)
        schema:
          type: string
          maxLength: 255
      - name: ispublic
        in: query
        description: Whether this DNS server can be used by accounts other than the owner to create and manage DNS zones
        schema:
          type: boolean
      - name: port
        in: query
        description: Port number of the external DNS server
        schema:
          type: integer
          format: int32
      - name: publicdomainsuffix
        in: query
        description: Domain suffix that restricts DNS zones created by non-owner accounts to subdomains of this suffix (for example, sub.example.com under example.com)
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addDnsServer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  adddnsserverresponse:
                    oneOf:
                    - &id009
                      $ref: '#/components/schemas/DnsServer'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id009
                        - type: array
                          items: *id009
                required:
                - adddnsserverresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  adddnsserverresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - adddnsserverresponse
      x-cloudstack-command: addDnsServer
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /addGloboDnsHost:
    get:
      operationId: addGloboDnsHost
      summary: Adds the GloboDNS external host
      description: |-
        Adds the GloboDNS external host

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GloboDnsHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addGloboDnsHost
          default: addGloboDnsHost
      - $ref: '#/components/parameters/response'
      - name: password
        in: query
        description: Password for GloboDNS
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: url
        in: query
        description: GloboDNS url
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Username for GloboDNS
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addGloboDnsHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addglobodnshostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addglobodnshostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addglobodnshostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addglobodnshostresponse
      x-cloudstack-command: addGloboDnsHost
      x-cloudstack-async: true
      x-cloudstack-since: 4.5.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /addGuestOs:
    get:
      operationId: addGuestOs
      summary: Add a new guest OS type
      description: |-
        Add a new guest OS type

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GuestO
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addGuestOs
          default: addGuestOs
      - $ref: '#/components/parameters/response'
      - name: oscategoryid
        in: query
        description: ID of Guest OS category
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listOsCategories
      - name: osdisplayname
        in: query
        description: Unique display name for Guest OS
        required: true
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: Map of (key/value pairs). Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: forDisplay
        in: query
        description: whether this guest OS is available for end users
        schema:
          type: boolean
      - name: name
        in: query
        description: Optional name for Guest OS
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addGuestOs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addguestosresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addguestosresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addguestosresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addguestosresponse
      x-cloudstack-command: addGuestOs
      x-cloudstack-async: true
      x-cloudstack-since: 4.4.0
      x-cloudstack-jobresult-schema: '#/components/schemas/GuestO'
  /addGuestOsMapping:
    get:
      operationId: addGuestOsMapping
      summary: Adds a guest OS name to hypervisor OS name mapping
      description: |-
        Adds a guest OS name to hypervisor OS name mapping

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GuestOsMapping
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addGuestOsMapping
          default: addGuestOsMapping
      - $ref: '#/components/parameters/response'
      - name: hypervisor
        in: query
        description: 'Hypervisor type. One of : XenServer, KVM, VMWare'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hypervisorversion
        in: query
        description: Hypervisor version to create the mapping. Use 'default' for default versions. Please check hypervisor capabilities for correct version
        required: true
        schema:
          type: string
          maxLength: 255
      - name: osnameforhypervisor
        in: query
        description: OS name specific to the hypervisor
        required: true
        schema:
          type: string
          maxLength: 255
      - name: forced
        in: query
        description: Forces add user defined guest os mapping, overrides any existing user defined mapping
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: osdisplayname
        in: query
        description: Display Name of Guest OS standard type. Either Display Name or UUID must be passed
        schema:
          type: string
          maxLength: 255
      - name: osmappingcheckenabled
        in: query
        description: When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: ostypeid
        in: query
        description: UUID of Guest OS type. Either the UUID or Display Name must be passed
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
      responses:
        '200':
          description: Successful invocation of `addGuestOsMapping`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addguestosmappingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addguestosmappingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addguestosmappingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addguestosmappingresponse
      x-cloudstack-command: addGuestOsMapping
      x-cloudstack-async: true
      x-cloudstack-since: 4.4.0
      x-cloudstack-related:
      - updateGuestOsMapping
      x-cloudstack-jobresult-schema: '#/components/schemas/GuestOsMapping'
  /addHost:
    get:
      operationId: addHost
      summary: Adds a new host.
      tags:
      - Host
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addHost
          default: addHost
      - $ref: '#/components/parameters/response'
      - name: hypervisor
        in: query
        description: Hypervisor type of the host
        required: true
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: The Pod ID for the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: url
        in: query
        description: 'The host URL, optionally add ssh port (format: ''host:port'') for KVM hosts, otherwise falls back to the port defined at the config ''kvm.host.discovery.ssh.port'''
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID for the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: allocationstate
        in: query
        description: Allocation state of this Host for allocation of new resources
        schema:
          type: string
          maxLength: 255
      - name: clusterid
        in: query
        description: The cluster ID for the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: clustername
        in: query
        description: The cluster name for the host
        schema:
          type: string
          maxLength: 255
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: hosttags
        in: query
        description: List of tags to be added to the host. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: password
        in: query
        description: The password for the host; required to be passed for hypervisors other than VMWare
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroups
        in: query
        description: comma separated list of storage access groups for the host. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
      - name: username
        in: query
        description: The username for the host; required to be passed for hypervisors other than VMWare
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addhostresponse:
                    oneOf:
                    - &id010
                      $ref: '#/components/schemas/Host'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id010
                        - type: array
                          items: *id010
                required:
                - addhostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addhostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addhostresponse
      x-cloudstack-command: addHost
      x-cloudstack-async: false
      x-cloudstack-related:
      - addBaremetalHost
      - cancelHostAsDegraded
      - declareHostAsDegraded
      - listHosts
      - reconnectHost
  /addImageStore:
    get:
      operationId: addImageStore
      summary: Adds backup image store.
      tags:
      - ImageStore
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addImageStore
          default: addImageStore
      - $ref: '#/components/parameters/response'
      - name: provider
        in: query
        description: The image store provider name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'The details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: name
        in: query
        description: The name for the image store
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The URL for the image store
        schema:
          type: string
          maxLength: 2048
      - name: zoneid
        in: query
        description: The Zone ID for the image store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `addImageStore`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addimagestoreresponse:
                    oneOf:
                    - &id011
                      $ref: '#/components/schemas/ImageStore'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id011
                        - type: array
                          items: *id011
                required:
                - addimagestoreresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addimagestoreresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addimagestoreresponse
      x-cloudstack-command: addImageStore
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - addSecondaryStorage
      - listSwifts
  /addImageStoreS3:
    get:
      operationId: addImageStoreS3
      summary: Adds S3 Image Store
      tags:
      - ImageStoreS3
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addImageStoreS3
          default: addImageStoreS3
      - $ref: '#/components/parameters/response'
      - name: accesskey
        in: query
        description: S3 access key
        required: true
        schema:
          type: string
          maxLength: 255
      - name: bucket
        in: query
        description: Name of the storage bucket
        required: true
        schema:
          type: string
          maxLength: 255
      - name: endpoint
        in: query
        description: S3 endpoint
        required: true
        schema:
          type: string
          maxLength: 255
      - name: secretkey
        in: query
        description: S3 secret key
        required: true
        schema:
          type: string
          maxLength: 255
      - name: connectiontimeout
        in: query
        description: Connection timeout (milliseconds)
        schema:
          type: integer
          format: int32
      - name: connectionttl
        in: query
        description: Connection TTL (milliseconds)
        schema:
          type: integer
          format: int32
      - name: maxerrorretry
        in: query
        description: Maximum number of times to retry on error
        schema:
          type: integer
          format: int32
      - name: s3signer
        in: query
        description: Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType
        schema:
          type: string
          maxLength: 255
      - name: sockettimeout
        in: query
        description: Socket timeout (milliseconds)
        schema:
          type: integer
          format: int32
      - name: usehttps
        in: query
        description: Use HTTPS instead of HTTP
        schema:
          type: boolean
      - name: usetcpkeepalive
        in: query
        description: Whether TCP keep-alive is used
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `addImageStoreS3`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addimagestores3response:
                    oneOf:
                    - &id012
                      $ref: '#/components/schemas/ImageStore'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id012
                        - type: array
                          items: *id012
                required:
                - addimagestores3response
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addimagestores3response:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addimagestores3response
      x-cloudstack-command: addImageStoreS3
      x-cloudstack-async: false
      x-cloudstack-since: 4.7.0
      x-cloudstack-related:
      - addImageStore
      - addSecondaryStorage
      - addSwift
      - listImageStores
      - listSwifts
  /addIpToNic:
    get:
      operationId: addIpToNic
      summary: Assigns secondary IP to NIC
      description: |-
        Assigns secondary IP to NIC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - IpToNic
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addIpToNic
          default: addIpToNic
      - $ref: '#/components/parameters/response'
      - name: nicid
        in: query
        description: The ID of the NIC to which you want to assign private IP
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listNics
        - updateVmNic
      - name: description
        in: query
        description: Description of the secondary IP address
        schema:
          type: string
          maxLength: 2048
      - name: ipaddress
        in: query
        description: Secondary IP Address
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addIpToNic`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addiptonicresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addiptonicresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addiptonicresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addiptonicresponse
      x-cloudstack-command: addIpToNic
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/IpToNic'
  /addKubernetesSupportedVersion:
    get:
      operationId: addKubernetesSupportedVersion
      summary: Add a supported Kubernetes version
      tags:
      - KubernetesSupportedVersion
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addKubernetesSupportedVersion
          default: addKubernetesSupportedVersion
      - $ref: '#/components/parameters/response'
      - name: mincpunumber
        in: query
        description: The minimum number of CPUs to be set with the Kubernetes version
        required: true
        schema:
          type: integer
          format: int32
      - name: minmemory
        in: query
        description: The minimum RAM size in MB to be set with the Kubernetes version
        required: true
        schema:
          type: integer
          format: int32
      - name: semanticversion
        in: query
        description: The semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format
        required: true
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: checksum
        in: query
        description: |-
          The checksum value of the binaries ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: directdownload
        in: query
        description: If set to true the Kubernetes supported version ISO will bypass Secondary Storage and be downloaded to Primary Storage on deployment. Default is false
        schema:
          type: boolean
        x-cloudstack-since: 4.18.2
      - name: name
        in: query
        description: The name of the Kubernetes supported version
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The URL of the binaries ISO for Kubernetes supported version
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of the zone in which Kubernetes supported version will be available
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `addKubernetesSupportedVersion`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addkubernetessupportedversionresponse:
                    oneOf:
                    - &id013
                      $ref: '#/components/schemas/KubernetesSupportedVersion'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id013
                        - type: array
                          items: *id013
                required:
                - addkubernetessupportedversionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addkubernetessupportedversionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addkubernetessupportedversionresponse
      x-cloudstack-command: addKubernetesSupportedVersion
      x-cloudstack-async: false
      x-cloudstack-related:
      - getUploadParamsForKubernetesSupportedVersion
      - listKubernetesSupportedVersions
      - updateKubernetesSupportedVersion
  /addLdapConfiguration:
    get:
      operationId: addLdapConfiguration
      summary: Add a new Ldap Configuration
      tags:
      - LdapConfiguration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addLdapConfiguration
          default: addLdapConfiguration
      - $ref: '#/components/parameters/response'
      - name: hostname
        in: query
        description: Hostname
        required: true
        schema:
          type: string
          maxLength: 255
      - name: port
        in: query
        description: Port
        required: true
        schema:
          type: integer
          format: int32
      - name: domainid
        in: query
        description: Linked Domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      responses:
        '200':
          description: Successful invocation of `addLdapConfiguration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addldapconfigurationresponse:
                    oneOf:
                    - &id014
                      $ref: '#/components/schemas/LdapConfiguration'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id014
                        - type: array
                          items: *id014
                required:
                - addldapconfigurationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addldapconfigurationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addldapconfigurationresponse
      x-cloudstack-command: addLdapConfiguration
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
  /addNetscalerLoadBalancer:
    get:
      operationId: addNetscalerLoadBalancer
      summary: Adds a netscaler load balancer device
      description: |-
        Adds a netscaler load balancer device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetscalerLoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addNetscalerLoadBalancer
          default: addNetscalerLoadBalancer
      - $ref: '#/components/parameters/response'
      - name: networkdevicetype
        in: query
        description: Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer
        required: true
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: Credentials to reach netscaler load balancer device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: url
        in: query
        description: URL of the netscaler load balancer appliance.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Credentials to reach netscaler load balancer device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: gslbprovider
        in: query
        description: True if NetScaler device being added is for providing GSLB service
        schema:
          type: boolean
      - name: gslbproviderprivateip
        in: query
        description: Private IP of the site
        schema:
          type: string
          maxLength: 255
      - name: gslbproviderpublicip
        in: query
        description: Public IP of the site
        schema:
          type: string
          maxLength: 255
      - name: isexclusivegslbprovider
        in: query
        description: True if NetScaler device being added is for providing GSLB service exclusively and can not be used for LB
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `addNetscalerLoadBalancer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnetscalerloadbalancerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addnetscalerloadbalancerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnetscalerloadbalancerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addnetscalerloadbalancerresponse
      x-cloudstack-command: addNetscalerLoadBalancer
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/NetscalerLoadBalancer'
  /addNetworkDevice:
    get:
      operationId: addNetworkDevice
      summary: 'Adds a network device of one of the following types: ExternalDhcp, ExternalFirewall, ExternalLoadBalancer, PxeServer'
      tags:
      - NetworkDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addNetworkDevice
          default: addNetworkDevice
      - $ref: '#/components/parameters/response'
      - name: networkdeviceparameterlist
        in: query
        description: Parameters for network device. Map parameter. CloudStack expects it index-encoded as `networkdeviceparameterlist[0].key=k&networkdeviceparameterlist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: networkdevicetype
        in: query
        description: Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addNetworkDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnetworkdeviceresponse:
                    oneOf:
                    - &id015
                      $ref: '#/components/schemas/NetworkDevice'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id015
                        - type: array
                          items: *id015
                required:
                - addnetworkdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnetworkdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addnetworkdeviceresponse
      x-cloudstack-command: addNetworkDevice
      x-cloudstack-async: false
  /addNetworkServiceProvider:
    get:
      operationId: addNetworkServiceProvider
      summary: Adds a network serviceProvider to a physical network
      description: |-
        Adds a network serviceProvider to a physical network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkServiceProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addNetworkServiceProvider
          default: addNetworkServiceProvider
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name for the physical network service provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID to add the provider to
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: destinationphysicalnetworkid
        in: query
        description: The destination Physical Network ID to bridge to
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: servicelist
        in: query
        description: The list of services to be enabled for this physical network service provider. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `addNetworkServiceProvider`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnetworkserviceproviderresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addnetworkserviceproviderresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnetworkserviceproviderresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addnetworkserviceproviderresponse
      x-cloudstack-command: addNetworkServiceProvider
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/NetworkServiceProvider'
  /addNicToVirtualMachine:
    get:
      operationId: addNicToVirtualMachine
      summary: Adds Instance to specified network by creating a NIC
      description: |-
        Adds Instance to specified network by creating a NIC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addNicToVirtualMachine
          default: addNicToVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: virtualmachineid
        in: query
        description: Instance ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: dhcpoptions
        in: query
        description: 'DHCP options which are passed to the NIC Example: dhcpoptions[0].dhcp:114=url&dhcpoptions[0].dhcp:66=www.test.com. Map parameter. CloudStack expects it index-encoded as `dhcpoptions[0].key=k&dhcpoptions[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: ipaddress
        in: query
        description: IP Address for the new Network
        schema:
          type: string
          maxLength: 255
      - name: macaddress
        in: query
        description: Mac Address for the new Network
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addNicToVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnictovirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addnictovirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnictovirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addnictovirtualmachineresponse
      x-cloudstack-command: addNicToVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachine
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /addNiciraNvpDevice:
    get:
      operationId: addNiciraNvpDevice
      summary: Adds a Nicira NVP device
      description: |-
        Adds a Nicira NVP device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NiciraNvpDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addNiciraNvpDevice
          default: addNiciraNvpDevice
      - $ref: '#/components/parameters/response'
      - name: hostname
        in: query
        description: Hostname of ip address of the Nicira NVP Controller.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: Credentials to access the Nicira Controller API
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: transportzoneuuid
        in: query
        description: The Transportzone UUID configured on the Nicira Controller
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Credentials to access the Nicira Controller API
        required: true
        schema:
          type: string
          maxLength: 255
      - name: l2gatewayserviceuuid
        in: query
        description: The L2 Gateway Service UUID configured on the Nicira Controller
        schema:
          type: string
          maxLength: 255
      - name: l3gatewayserviceuuid
        in: query
        description: The L3 Gateway Service UUID configured on the Nicira Controller
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addNiciraNvpDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addniciranvpdeviceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addniciranvpdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addniciranvpdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addniciranvpdeviceresponse
      x-cloudstack-command: addNiciraNvpDevice
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/NiciraNvpDevice'
  /addNodesToKubernetesCluster:
    get:
      operationId: addNodesToKubernetesCluster
      summary: Add nodes as workers to an existing CKS cluster.
      description: |-
        Add nodes as workers to an existing CKS cluster.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addNodesToKubernetesCluster
          default: addNodesToKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - addNodesToKubernetesCluster
        - createKubernetesCluster
        - listKubernetesClusters
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
        - upgradeKubernetesCluster
      - name: nodeids
        in: query
        description: comma separated list of (external) node (physical or virtual machines) IDs that need to beadded as worker nodes to an existing managed Kubernetes cluster (CKS). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
        - updateVmNicIp
      - name: manualupgrade
        in: query
        description: (optional) indicates if the node is marked for manual upgrade and excluded from the Kubernetes cluster upgrade operation
        schema:
          type: boolean
      - name: mountcksisoonvr
        in: query
        description: (optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `addNodesToKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnodestokubernetesclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addnodestokubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addnodestokubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addnodestokubernetesclusterresponse
      x-cloudstack-command: addNodesToKubernetesCluster
      x-cloudstack-async: true
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - createKubernetesCluster
      - listKubernetesClusters
      - scaleKubernetesCluster
      - startKubernetesCluster
      - updateKubernetesClusterAffinityGroups
      - upgradeKubernetesCluster
      x-cloudstack-jobresult-schema: '#/components/schemas/KubernetesCluster'
  /addObjectStoragePool:
    get:
      operationId: addObjectStoragePool
      summary: Adds a object storage pool
      tags:
      - ObjectStoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addObjectStoragePool
          default: addObjectStoragePool
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: the name for the object store
        required: true
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: the object store provider name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: the URL for the object store
        required: true
        schema:
          type: string
          maxLength: 2048
      - name: details
        in: query
        description: 'the details for the object store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: size
        in: query
        description: the total size of the object store in GiB. Used for tracking capacity and sending alerts
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.21'
      - name: tags
        in: query
        description: the tags for the storage pool
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addObjectStoragePool`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addobjectstoragepoolresponse:
                    oneOf:
                    - &id016
                      $ref: '#/components/schemas/ObjectStoragePool'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id016
                        - type: array
                          items: *id016
                required:
                - addobjectstoragepoolresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addobjectstoragepoolresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addobjectstoragepoolresponse
      x-cloudstack-command: addObjectStoragePool
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /addOpenDaylightController:
    get:
      operationId: addOpenDaylightController
      summary: Adds an OpenDyalight controler
      description: |-
        Adds an OpenDyalight controler

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - OpenDaylightController
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addOpenDaylightController
          default: addOpenDaylightController
      - $ref: '#/components/parameters/response'
      - name: password
        in: query
        description: Credential to access the OpenDaylight API
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: url
        in: query
        description: Api URL of the OpenDaylight Controller.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Username to access the OpenDaylight API
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addOpenDaylightController`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addopendaylightcontrollerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addopendaylightcontrollerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addopendaylightcontrollerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addopendaylightcontrollerresponse
      x-cloudstack-command: addOpenDaylightController
      x-cloudstack-async: true
      x-cloudstack-related:
      - deleteOpenDaylightController
      x-cloudstack-jobresult-schema: '#/components/schemas/OpenDaylightController'
  /addOsCategory:
    get:
      operationId: addOsCategory
      summary: Adds a new OS category
      tags:
      - OsCategory
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addOsCategory
          default: addOsCategory
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the OS category
        required: true
        schema:
          type: string
          maxLength: 255
      - name: isfeatured
        in: query
        description: Whether the category is featured or not
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `addOsCategory`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addoscategoryresponse:
                    oneOf:
                    - &id017
                      $ref: '#/components/schemas/OsCategory'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id017
                        - type: array
                          items: *id017
                required:
                - addoscategoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addoscategoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addoscategoryresponse
      x-cloudstack-command: addOsCategory
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - listOsCategories
  /addPaloAltoFirewall:
    get:
      operationId: addPaloAltoFirewall
      summary: Adds a Palo Alto firewall device
      description: |-
        Adds a Palo Alto firewall device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PaloAltoFirewall
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addPaloAltoFirewall
          default: addPaloAltoFirewall
      - $ref: '#/components/parameters/response'
      - name: networkdevicetype
        in: query
        description: Supports only PaloAltoFirewall
        required: true
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: Credentials to reach Palo Alto firewall device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: url
        in: query
        description: URL of the Palo Alto appliance.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Credentials to reach Palo Alto firewall device
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addPaloAltoFirewall`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addpaloaltofirewallresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addpaloaltofirewallresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addpaloaltofirewallresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addpaloaltofirewallresponse
      x-cloudstack-command: addPaloAltoFirewall
      x-cloudstack-async: true
      x-cloudstack-related:
      - configurePaloAltoFirewall
      - listPaloAltoFirewalls
      x-cloudstack-jobresult-schema: '#/components/schemas/PaloAltoFirewall'
  /addRegion:
    get:
      operationId: addRegion
      summary: Adds a Region
      tags:
      - Region
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addRegion
          default: addRegion
      - $ref: '#/components/parameters/response'
      - name: endpoint
        in: query
        description: Region service endpoint
        required: true
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: Id of the Region
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: Name of the region
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addRegion`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addregionresponse:
                    oneOf:
                    - &id018
                      $ref: '#/components/schemas/Region'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id018
                        - type: array
                          items: *id018
                required:
                - addregionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addregionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addregionresponse
      x-cloudstack-command: addRegion
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateRegion
  /addResourceDetail:
    get:
      operationId: addResourceDetail
      summary: Adds detail for the Resource.
      description: |-
        Adds detail for the Resource.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ResourceDetail
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addResourceDetail
          default: addResourceDetail
      - $ref: '#/components/parameters/response'
      - name: details
        in: query
        description: Map of (key/value pairs). Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        required: true
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: resourceid
        in: query
        description: Resource ID to create the details for
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      - name: fordisplay
        in: query
        description: Pass false if you want this detail to be disabled for the regular User. True by default
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `addResourceDetail`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addresourcedetailresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addresourcedetailresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addresourcedetailresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addresourcedetailresponse
      x-cloudstack-command: addResourceDetail
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /addSecondaryStorage:
    get:
      operationId: addSecondaryStorage
      summary: Adds secondary storage.
      tags:
      - SecondaryStorage
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addSecondaryStorage
          default: addSecondaryStorage
      - $ref: '#/components/parameters/response'
      - name: url
        in: query
        description: The URL for the secondary storage
        required: true
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].copytemplatesfromothersecondarystorages=true. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: zoneid
        in: query
        description: The Zone ID for the secondary storage
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `addSecondaryStorage`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addsecondarystorageresponse:
                    oneOf:
                    - &id019
                      $ref: '#/components/schemas/ImageStore'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id019
                        - type: array
                          items: *id019
                required:
                - addsecondarystorageresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addsecondarystorageresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addsecondarystorageresponse
      x-cloudstack-command: addSecondaryStorage
      x-cloudstack-async: false
      x-cloudstack-related:
      - listSwifts
  /addStratosphereSsp:
    get:
      operationId: addStratosphereSsp
      summary: Adds stratosphere ssp server
      tags:
      - StratosphereSsp
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addStratosphereSsp
          default: addStratosphereSsp
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Stratosphere ssp API name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: Stratosphere ssp server URL
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: password
        in: query
        description: Stratosphere ssp API password
        schema:
          type: string
          maxLength: 255
      - name: tenantuuid
        in: query
        description: Stratosphere ssp tenant UUID
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Stratosphere ssp API username
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addStratosphereSsp`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addstratospheresspresponse:
                    oneOf:
                    - &id020
                      $ref: '#/components/schemas/StratosphereSsp'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id020
                        - type: array
                          items: *id020
                required:
                - addstratospheresspresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addstratospheresspresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addstratospheresspresponse
      x-cloudstack-command: addStratosphereSsp
      x-cloudstack-async: false
  /addSwift:
    get:
      operationId: addSwift
      summary: Adds Swift.
      tags:
      - Swift
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addSwift
          default: addSwift
      - $ref: '#/components/parameters/response'
      - name: url
        in: query
        description: The URL for swift
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: The account for swift
        schema:
          type: string
          maxLength: 255
      - name: key
        in: query
        description: key for the user for swift
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: The username for swift
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addSwift`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addswiftresponse:
                    oneOf:
                    - &id021
                      $ref: '#/components/schemas/ImageStore'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id021
                        - type: array
                          items: *id021
                required:
                - addswiftresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addswiftresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addswiftresponse
      x-cloudstack-command: addSwift
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - addImageStore
      - addSecondaryStorage
      - listSwifts
  /addTrafficMonitor:
    get:
      operationId: addTrafficMonitor
      summary: Adds Traffic Monitor Host for Direct Network Usage
      tags:
      - TrafficMonitor
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addTrafficMonitor
          default: addTrafficMonitor
      - $ref: '#/components/parameters/response'
      - name: url
        in: query
        description: URL of the traffic monitor Host
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: Zone in which to add the external firewall appliance.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: excludezones
        in: query
        description: Traffic going into the listed zones will not be metered
        schema:
          type: string
          maxLength: 255
      - name: includezones
        in: query
        description: Traffic going into the listed zones will be metered
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addTrafficMonitor`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addtrafficmonitorresponse:
                    oneOf:
                    - &id022
                      $ref: '#/components/schemas/TrafficMonitor'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id022
                        - type: array
                          items: *id022
                required:
                - addtrafficmonitorresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addtrafficmonitorresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addtrafficmonitorresponse
      x-cloudstack-command: addTrafficMonitor
      x-cloudstack-async: false
  /addTrafficType:
    get:
      operationId: addTrafficType
      summary: Adds traffic type to a physical network
      description: |-
        Adds traffic type to a physical network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TrafficType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addTrafficType
          default: addTrafficType
      - $ref: '#/components/parameters/response'
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updatePhysicalNetwork
      - name: traffictype
        in: query
        description: The trafficType to be added to the physical network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hypervnetworklabel
        in: query
        description: The network name label of the physical device dedicated to this traffic on a Hyperv host
        schema:
          type: string
          maxLength: 255
      - name: isolationmethod
        in: query
        description: Used if physical network has multiple isolation types and traffic type is public. Choose which isolation method. Valid options currently 'vlan' or 'vxlan', defaults to 'vlan'.
        schema:
          type: string
          maxLength: 255
      - name: kvmnetworklabel
        in: query
        description: The network name label of the physical device dedicated to this traffic on a KVM host
        schema:
          type: string
          maxLength: 255
      - name: ovm3networklabel
        in: query
        description: The network name of the physical device dedicated to this traffic on an OVM3 host
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: The VLAN id to be used for Management traffic by VMware host
        schema:
          type: string
          maxLength: 255
      - name: vmwarenetworklabel
        in: query
        description: The network name label of the physical device dedicated to this traffic on a VMware host
        schema:
          type: string
          maxLength: 255
      - name: xennetworklabel
        in: query
        description: The network name label of the physical device dedicated to this traffic on a XenServer host
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addTrafficType`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addtraffictyperesponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addtraffictyperesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addtraffictyperesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addtraffictyperesponse
      x-cloudstack-command: addTrafficType
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - listTrafficTypes
      x-cloudstack-jobresult-schema: '#/components/schemas/TrafficType'
  /addTungstenFabricNetworkGatewayToLogicalRouter:
    get:
      operationId: addTungstenFabricNetworkGatewayToLogicalRouter
      summary: Add Tungsten-Fabric network gateway to logical router
      description: |-
        Add Tungsten-Fabric network gateway to logical router

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Router
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addTungstenFabricNetworkGatewayToLogicalRouter
          default: addTungstenFabricNetworkGatewayToLogicalRouter
      - $ref: '#/components/parameters/response'
      - name: logicalrouteruuid
        in: query
        description: Tungsten-Fabric logical router uuid
        required: true
        schema:
          type: string
          maxLength: 255
      - name: networkuuid
        in: query
        description: Tungsten-Fabric network uuid
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `addTungstenFabricNetworkGatewayToLogicalRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addtungstenfabricnetworkgatewaytologicalrouterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addtungstenfabricnetworkgatewaytologicalrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addtungstenfabricnetworkgatewaytologicalrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addtungstenfabricnetworkgatewaytologicalrouterresponse
      x-cloudstack-command: addTungstenFabricNetworkGatewayToLogicalRouter
      x-cloudstack-async: true
      x-cloudstack-related:
      - createTungstenFabricLogicalRouter
      - listTungstenFabricLogicalRouter
      - removeTungstenFabricNetworkGatewayFromLogicalRouter
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricPolicy'
  /addTungstenFabricPolicyRule:
    get:
      operationId: addTungstenFabricPolicyRule
      summary: Add Tungsten-Fabric policy rule
      description: |-
        Add Tungsten-Fabric policy rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricPolicyRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addTungstenFabricPolicyRule
          default: addTungstenFabricPolicyRule
      - $ref: '#/components/parameters/response'
      - name: action
        in: query
        description: Tungsten-Fabric policy rule action
        required: true
        schema:
          type: string
          maxLength: 255
      - name: destendport
        in: query
        description: Tungsten-Fabric policy rule destination end port
        required: true
        schema:
          type: integer
          format: int32
      - name: destipprefix
        in: query
        description: Tungsten-Fabric policy rule destination ip prefix
        required: true
        schema:
          type: string
          maxLength: 255
      - name: destipprefixlen
        in: query
        description: Tungsten-Fabric policy rule destination ip prefix length
        required: true
        schema:
          type: integer
          format: int32
      - name: destnetwork
        in: query
        description: Tungsten-Fabric policy rule destination network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: deststartport
        in: query
        description: Tungsten-Fabric policy rule destination start port
        required: true
        schema:
          type: integer
          format: int32
      - name: direction
        in: query
        description: Tungsten-Fabric policy rule direction
        required: true
        schema:
          type: string
          maxLength: 255
      - name: policyuuid
        in: query
        description: The UUID of Tungsten-Fabric policy
        required: true
        schema:
          type: string
          maxLength: 255
      - name: protocol
        in: query
        description: Tungsten-Fabric policy rule protocol
        required: true
        schema:
          type: string
          maxLength: 255
      - name: srcendport
        in: query
        description: Tungsten-Fabric policy rule source end port
        required: true
        schema:
          type: integer
          format: int32
      - name: srcipprefix
        in: query
        description: Tungsten-Fabric policy rule source ip prefix
        required: true
        schema:
          type: string
          maxLength: 255
      - name: srcipprefixlen
        in: query
        description: Tungsten-Fabric policy rule source ip prefix length
        required: true
        schema:
          type: integer
          format: int32
      - name: srcnetwork
        in: query
        description: Tungsten-Fabric policy rule source network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: srcstartport
        in: query
        description: Tungsten-Fabric policy rule source start port
        required: true
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `addTungstenFabricPolicyRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addtungstenfabricpolicyruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addtungstenfabricpolicyruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addtungstenfabricpolicyruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addtungstenfabricpolicyruleresponse
      x-cloudstack-command: addTungstenFabricPolicyRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricPolicyRule'
  /addUcsManager:
    get:
      operationId: addUcsManager
      summary: Adds a Ucs manager
      tags:
      - UcsManager
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addUcsManager
          default: addUcsManager
      - $ref: '#/components/parameters/response'
      - name: password
        in: query
        description: The password of UCS
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The name of UCS URL
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: The username of UCS
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID for the ucs manager
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: name
        in: query
        description: The name of UCS manager
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addUcsManager`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  adducsmanagerresponse:
                    oneOf:
                    - &id023
                      $ref: '#/components/schemas/UcsManager'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id023
                        - type: array
                          items: *id023
                required:
                - adducsmanagerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  adducsmanagerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - adducsmanagerresponse
      x-cloudstack-command: addUcsManager
      x-cloudstack-async: false
      x-cloudstack-related:
      - listUcsManagers
  /addUserToProject:
    get:
      operationId: addUserToProject
      summary: Adds User to a project
      description: |-
        Adds User to a project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addUserToProject
          default: addUserToProject
      - $ref: '#/components/parameters/response'
      - name: projectid
        in: query
        description: ID of the project to add the User to
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      - name: username
        in: query
        description: Name of the User to be added to the project
        required: true
        schema:
          type: string
          maxLength: 255
      - name: email
        in: query
        description: Email ID of User to which invitation to the project is going to be sent
        schema:
          type: string
          maxLength: 255
      - name: projectroleid
        in: query
        description: ID of the project role
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectRoles
        - updateProjectRole
      - name: roletype
        in: query
        description: Project role type to be assigned to the User - Admin/Regular
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addUserToProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addusertoprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addusertoprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addusertoprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addusertoprojectresponse
      x-cloudstack-command: addUserToProject
      x-cloudstack-async: true
      x-cloudstack-since: '4.14'
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /addVirtualMachinesToKubernetesCluster:
    get:
      operationId: addVirtualMachinesToKubernetesCluster
      summary: Add VMs to an ExternalManaged kubernetes cluster.
      description: Add VMs to an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addVirtualMachinesToKubernetesCluster
          default: addVirtualMachinesToKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKubernetesCluster
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
      - name: virtualmachineids
        in: query
        description: The IDs of the VMs to add to the cluster. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: iscontrolnode
        in: query
        description: Is control node or not? Defaults to false.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `addVirtualMachinesToKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addvirtualmachinestokubernetesclusterresponse:
                    oneOf:
                    - &id024
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id024
                        - type: array
                          items: *id024
                required:
                - addvirtualmachinestokubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addvirtualmachinestokubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addvirtualmachinestokubernetesclusterresponse
      x-cloudstack-command: addVirtualMachinesToKubernetesCluster
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /addVmwareDc:
    get:
      operationId: addVmwareDc
      summary: Adds a VMware datacenter to specified zone
      tags:
      - VmwareDc
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addVmwareDc
          default: addVmwareDc
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of VMware datacenter to be added to specified zone.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: vcenter
        in: query
        description: The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: password
        in: query
        description: The password for specified username.
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: The Username required to connect to resource.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addVmwareDc`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addvmwaredcresponse:
                    oneOf:
                    - &id025
                      $ref: '#/components/schemas/VmwareDc'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id025
                        - type: array
                          items: *id025
                required:
                - addvmwaredcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addvmwaredcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addvmwaredcresponse
      x-cloudstack-command: addVmwareDc
      x-cloudstack-async: false
  /addVpnUser:
    get:
      operationId: addVpnUser
      summary: Adds VPN Users
      description: |-
        Adds VPN Users

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnUser
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addVpnUser
          default: addVpnUser
      - $ref: '#/components/parameters/response'
      - name: password
        in: query
        description: Password for the username
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Username for the VPN User
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: An optional Account for the VPN User. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the VPN User. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: projectid
        in: query
        description: Add VPN User to the specific project
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addVpnUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addvpnuserresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - addvpnuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addvpnuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addvpnuserresponse
      x-cloudstack-command: addVpnUser
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/VpnUser'
  /addWebhookFilter:
    get:
      operationId: addWebhookFilter
      summary: Adds a Webhook filter
      tags:
      - WebhookFilter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: addWebhookFilter
          default: addWebhookFilter
      - $ref: '#/components/parameters/response'
      - name: value
        in: query
        description: Value for the Webhook which that will be matched
        required: true
        schema:
          type: string
          maxLength: 255
      - name: webhookid
        in: query
        description: ID for the Webhook
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addWebhookFilter
        - createWebhook
        - listWebhookDeliveries
        - updateWebhook
      - name: matchtype
        in: query
        description: Match type for the Webhook filter - Exact, Prefix, Suffix or Contains
        schema:
          type: string
          maxLength: 255
      - name: mode
        in: query
        description: Mode for the Webhook filter - Include or Exclude
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `addWebhookFilter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addwebhookfilterresponse:
                    oneOf:
                    - &id026
                      $ref: '#/components/schemas/Webhook'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id026
                        - type: array
                          items: *id026
                required:
                - addwebhookfilterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  addwebhookfilterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - addwebhookfilterresponse
      x-cloudstack-command: addWebhookFilter
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createWebhook
      - listWebhookDeliveries
      - updateWebhook
  /applyTungstenFabricPolicy:
    get:
      operationId: applyTungstenFabricPolicy
      summary: Apply Tungsten-Fabric policy
      description: |-
        Apply Tungsten-Fabric policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: applyTungstenFabricPolicy
          default: applyTungstenFabricPolicy
      - $ref: '#/components/parameters/response'
      - name: majorsequence
        in: query
        description: The major sequence of Tungsten-Fabric policy
        required: true
        schema:
          type: integer
          format: int32
      - name: minorsequence
        in: query
        description: The minor sequence of Tungsten-Fabric policy
        required: true
        schema:
          type: integer
          format: int32
      - name: networkuuid
        in: query
        description: The UUID of network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: policyuuid
        in: query
        description: The UUID of Tungsten-Fabric policy
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `applyTungstenFabricPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  applytungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - applytungstenfabricpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  applytungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - applytungstenfabricpolicyresponse
      x-cloudstack-command: applyTungstenFabricPolicy
      x-cloudstack-async: true
      x-cloudstack-related:
      - createTungstenFabricPolicy
      - listTungstenFabricPolicy
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricPolicy'
  /applyTungstenFabricTag:
    get:
      operationId: applyTungstenFabricTag
      summary: Apply Tungsten-Fabric tag
      description: |-
        Apply Tungsten-Fabric tag

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricTag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: applyTungstenFabricTag
          default: applyTungstenFabricTag
      - $ref: '#/components/parameters/response'
      - name: taguuid
        in: query
        description: The UUID of Tungsten-Fabric tag
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: applicationpolicysetuuid
        in: query
        description: The UUID of Tungsten-Fabric application policy set
        schema:
          type: string
          maxLength: 255
      - name: networkuuid
        in: query
        description: The UUID of networks. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: nicuuid
        in: query
        description: The UUID of NICs. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: policyuuid
        in: query
        description: The UUID of Tungsten-Fabric policy
        schema:
          type: string
          maxLength: 255
      - name: vmuuid
        in: query
        description: The UUID of Instances. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `applyTungstenFabricTag`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  applytungstenfabrictagresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - applytungstenfabrictagresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  applytungstenfabrictagresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - applytungstenfabrictagresponse
      x-cloudstack-command: applyTungstenFabricTag
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricTag'
  /archiveAlerts:
    get:
      operationId: archiveAlerts
      summary: Archive one or more alerts.
      tags:
      - Alert
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: archiveAlerts
          default: archiveAlerts
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: End date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: ids
        in: query
        description: The IDs of the alerts. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listAlertTypes
        - listAlerts
      - name: startdate
        in: query
        description: Start date range to archive alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: type
        in: query
        description: Archive by alert type
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `archiveAlerts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  archivealertsresponse:
                    oneOf:
                    - &id027
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id027
                        - type: array
                          items: *id027
                required:
                - archivealertsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  archivealertsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - archivealertsresponse
      x-cloudstack-command: archiveAlerts
      x-cloudstack-async: false
  /archiveEvents:
    get:
      operationId: archiveEvents
      summary: Archive one or more events.
      tags:
      - Event
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: archiveEvents
          default: archiveEvents
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: End date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: ids
        in: query
        description: The IDs of the events. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listEvents
      - name: startdate
        in: query
        description: Start date range to archive events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: type
        in: query
        description: Archive by event type
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `archiveEvents`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  archiveeventsresponse:
                    oneOf:
                    - &id028
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id028
                        - type: array
                          items: *id028
                required:
                - archiveeventsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  archiveeventsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - archiveeventsresponse
      x-cloudstack-command: archiveEvents
      x-cloudstack-async: false
  /archiveSnapshot:
    get:
      operationId: archiveSnapshot
      summary: Archives (moves) a Snapshot on primary storage to secondary storage
      description: |-
        Archives (moves) a Snapshot on primary storage to secondary storage

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Snapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: archiveSnapshot
          default: archiveSnapshot
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Snapshot
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - archiveSnapshot
        - copySnapshot
        - listSnapshots
      responses:
        '200':
          description: Successful invocation of `archiveSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  archivesnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - archivesnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  archivesnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - archivesnapshotresponse
      x-cloudstack-command: archiveSnapshot
      x-cloudstack-async: true
      x-cloudstack-related:
      - copySnapshot
      - listSnapshots
      x-cloudstack-jobresult-schema: '#/components/schemas/Snapshot'
  /assignCertToLoadBalancer:
    get:
      operationId: assignCertToLoadBalancer
      summary: Assigns a certificate to a load balancer rule
      description: |-
        Assigns a certificate to a load balancer rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: assignCertToLoadBalancer
          default: assignCertToLoadBalancer
      - $ref: '#/components/parameters/response'
      - name: certid
        in: query
        description: The ID of the certificate
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: lbruleid
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPortForwardingRule
        - updatePortForwardingRule
      - name: forced
        in: query
        description: Force assign the certificate. If there is a certificate assigned to the LB, it will be removed at first.
        schema:
          type: boolean
        x-cloudstack-since: '4.22'
      responses:
        '200':
          description: Successful invocation of `assignCertToLoadBalancer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assigncerttoloadbalancerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - assigncerttoloadbalancerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assigncerttoloadbalancerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - assigncerttoloadbalancerresponse
      x-cloudstack-command: assignCertToLoadBalancer
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /assignToGlobalLoadBalancerRule:
    get:
      operationId: assignToGlobalLoadBalancerRule
      summary: Assign load balancer rule or list of load balancer rules to a global load balancer rules.
      description: |-
        Assign load balancer rule or list of load balancer rules to a global load balancer rules.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GlobalLoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: assignToGlobalLoadBalancerRule
          default: assignToGlobalLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the global load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGlobalLoadBalancerRules
        - updateGlobalLoadBalancerRule
      - name: loadbalancerrulelist
        in: query
        description: The list load balancer rules that will be assigned to global load balancer rule. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updatePortForwardingRule
      - name: gslblbruleweightsmap
        in: query
        description: Map of LB rule id's and corresponding weights (between 1-100) in the GSLB rule, if not specified weight of a LB rule is defaulted to 1. Specified as 'gslblbruleweightsmap[0].loadbalancerid=UUID&gslblbruleweightsmap[0].weight=10'. Map parameter. CloudStack expects it index-encoded as `gslblbruleweightsmap[0].key=k&gslblbruleweightsmap[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `assignToGlobalLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assigntogloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - assigntogloballoadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assigntogloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - assigntogloballoadbalancerruleresponse
      x-cloudstack-command: assignToGlobalLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /assignToLoadBalancerRule:
    get:
      operationId: assignToLoadBalancerRule
      summary: Assigns an Instance or a list of Instances to a load balancer rule.
      description: |-
        Assigns an Instance or a list of Instances to a load balancer rule.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: assignToLoadBalancerRule
          default: assignToLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: virtualmachineids
        in: query
        description: The list of IDs of the Instance that are being assigned to the load balancer rule(i.e. virtualMachineIds=1,2,3). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: vmidipmap
        in: query
        description: 'VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75. (Optional, for VPC Conserve Mode) Pass vmnetworkid. Example: vmidipmap[0].vmnetworkid=NETWORK_TIER_UUID. Map parameter. CloudStack expects it index-encoded as `vmidipmap[0].key=k&vmidipmap[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `assignToLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assigntoloadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - assigntoloadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assigntoloadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - assigntoloadbalancerruleresponse
      x-cloudstack-command: assignToLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /assignVirtualMachine:
    get:
      operationId: assignVirtualMachine
      summary: Change ownership of an Instance from one account to another.
      description: Change ownership of an Instance from one account to another. This API is available for Basic zones with security groups and Advanced zones with guest networks. A root administrator can reassign an Instance from any account to any other account in any domain. A domain administrator can reassign an Instance to any account in the same domain.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: assignVirtualMachine
          default: assignVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: ID of the Instance to be moved
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: account
        in: query
        description: Account name of the new Instance owner.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Domain id of the new Instance owner.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: networkids
        in: query
        description: List of new network IDs in which the moved Instance will participate. In case no network ids are provided the Instance will be part of the default network for that zone. In case there is no network yet created for the new account the default network will be created. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: projectid
        in: query
        description: An optional project for the new Instance owner.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: securitygroupids
        in: query
        description: List of security group ids to be applied on the Instance. In case no security groups are provided the Instance is part of the default security group. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `assignVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignvirtualmachineresponse:
                    oneOf:
                    - &id029
                      $ref: '#/components/schemas/VirtualMachine'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id029
                        - type: array
                          items: *id029
                required:
                - assignvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - assignvirtualmachineresponse
      x-cloudstack-command: assignVirtualMachine
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
  /assignVirtualMachineToBackupOffering:
    get:
      operationId: assignVirtualMachineToBackupOffering
      summary: Assigns an Instance to a backup offering
      description: |-
        Assigns an Instance to a backup offering

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BackupOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: assignVirtualMachineToBackupOffering
          default: assignVirtualMachineToBackupOffering
      - $ref: '#/components/parameters/response'
      - name: backupofferingid
        in: query
        description: ID of the backup offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createBackupOffering
        - listBackupOfferings
        - updateBackupOffering
      - name: virtualmachineid
        in: query
        description: ID of the  Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `assignVirtualMachineToBackupOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignvirtualmachinetobackupofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - assignvirtualmachinetobackupofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignvirtualmachinetobackupofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - assignvirtualmachinetobackupofferingresponse
      x-cloudstack-command: assignVirtualMachineToBackupOffering
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /assignVolume:
    get:
      operationId: assignVolume
      summary: Changes ownership of a Volume from one Account to another.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: assignVolume
          default: assignVolume
      - $ref: '#/components/parameters/response'
      - name: volumeid
        in: query
        description: The ID of the volume to be reassigned.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: accountid
        in: query
        description: The ID of the Account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - updateAccount
      - name: projectid
        in: query
        description: The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `assignVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignvolumeresponse:
                    oneOf:
                    - &id030
                      $ref: '#/components/schemas/Volume'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id030
                        - type: array
                          items: *id030
                required:
                - assignvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  assignvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - assignvolumeresponse
      x-cloudstack-command: assignVolume
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0.0
      x-cloudstack-related:
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
  /associateDnsZoneToNetwork:
    get:
      operationId: associateDnsZoneToNetwork
      summary: Associates a DNS Zone with a Network for VM auto-registration
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: associateDnsZoneToNetwork
          default: associateDnsZoneToNetwork
      - $ref: '#/components/parameters/response'
      - name: dnszoneid
        in: query
        description: The ID of the DNS zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDnsZones
      - name: networkid
        in: query
        description: The ID of the network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: subdomain
        in: query
        description: Optional subdomain to append (e.g., 'dev' creates vm1.dev.example.com)
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `associateDnsZoneToNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  associatednszonetonetworkresponse:
                    oneOf:
                    - &id031
                      $ref: '#/components/schemas/DnsZoneToNetwork'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id031
                        - type: array
                          items: *id031
                required:
                - associatednszonetonetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  associatednszonetonetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - associatednszonetonetworkresponse
      x-cloudstack-command: associateDnsZoneToNetwork
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /associateIpAddress:
    get:
      operationId: associateIpAddress
      summary: Acquires and associates a public IP to an Account.
      description: |-
        Acquires and associates a public IP to an Account.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - IpAddress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: associateIpAddress
          default: associateIpAddress
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The Account to associate with this IP address
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the domain to associate with this IP address
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the IP to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: ipaddress
        in: query
        description: IP Address to be associated
        schema:
          type: string
          maxLength: 255
      - name: isportable
        in: query
        description: Should be set to true if public IP is required to be transferable across zones, if not specified defaults to false
        schema:
          type: boolean
      - name: networkid
        in: query
        description: The Network this IP address should be associated to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: projectid
        in: query
        description: Deploy Instance for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: regionid
        in: query
        description: Region ID from where portable IP is to be associated.
        schema:
          type: integer
          format: int32
      - name: vpcid
        in: query
        description: The VPC you want the IP address to be associated with
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: zoneid
        in: query
        description: The ID of the availability zone you want to acquire an public IP address from
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `associateIpAddress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  associateipaddressresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - associateipaddressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  associateipaddressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - associateipaddressresponse
      x-cloudstack-command: associateIpAddress
      x-cloudstack-async: true
      x-cloudstack-related:
      - associateIpAddress
      - listPublicIpAddresses
      - updateIpAddress
      x-cloudstack-jobresult-schema: '#/components/schemas/IpAddress'
  /associateUcsProfileToBlade:
    get:
      operationId: associateUcsProfileToBlade
      summary: Associate a profile to a blade
      description: |-
        Associate a profile to a blade

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - UcsProfileToBlade
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: associateUcsProfileToBlade
          default: associateUcsProfileToBlade
      - $ref: '#/components/parameters/response'
      - name: bladeid
        in: query
        description: Blade ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateUcsProfileToBlade
      - name: profiledn
        in: query
        description: Profile dn
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ucsmanagerid
        in: query
        description: UCS manager ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addUcsManager
        - listUcsManagers
      responses:
        '200':
          description: Successful invocation of `associateUcsProfileToBlade`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  associateucsprofiletobladeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - associateucsprofiletobladeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  associateucsprofiletobladeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - associateucsprofiletobladeresponse
      x-cloudstack-command: associateUcsProfileToBlade
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/AssociateUcsProfileToBladeResult'
  /attachIso:
    get:
      operationId: attachIso
      summary: Attaches an ISO to  an Instance.
      description: |-
        Attaches an ISO to  an Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Iso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: attachIso
          default: attachIso
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the ISO file
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: virtualmachineid
        in: query
        description: The ID of the  Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: forced
        in: query
        description: 'If true, ejects existing ISO before attaching on VMware. Default: false'
        schema:
          type: boolean
        x-cloudstack-since: 4.15.1
      responses:
        '200':
          description: Successful invocation of `attachIso`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  attachisoresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - attachisoresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  attachisoresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - attachisoresponse
      x-cloudstack-command: attachIso
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /attachVolume:
    get:
      operationId: attachVolume
      summary: Attaches a disk volume to  an Instance.
      description: |-
        Attaches a disk volume to  an Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: attachVolume
          default: attachVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the disk volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: virtualmachineid
        in: query
        description: the ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: deviceid
        in: query
        description: The ID of the device to map the volume to the guest OS. If no deviceID is informed, the next available deviceID will be chosen. Use 0 when volume needs to be attached as ROOT.<br>When using a linux operating system and the hypervisor XenServer, the devices IDs will be mapped as follows:<ul><li>0 maps to /dev/xvda;</li><li>1 maps to /dev/xvdb;</li><li>2 maps /dev/xvdc and so on.</li></ul>Please refer to the docs of your hypervisor for the correct mapping of the deviceID and the actual logical disk structure.
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `attachVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  attachvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - attachvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  attachvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - attachvolumeresponse
      x-cloudstack-command: attachVolume
      x-cloudstack-async: true
      x-cloudstack-related:
      - assignVolume
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /authorizeSecurityGroupEgress:
    get:
      operationId: authorizeSecurityGroupEgress
      summary: Authorizes a particular egress rule for this security group
      description: |-
        Authorizes a particular egress rule for this security group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SecurityGroupEgress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: authorizeSecurityGroupEgress
          default: authorizeSecurityGroupEgress
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: An optional account for the security group. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: The CIDR list associated. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: domainid
        in: query
        description: An optional domainId for the security group. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: endport
        in: query
        description: End port for this egress rule
        schema:
          type: integer
          format: int32
      - name: icmpcode
        in: query
        description: Error code for this icmp message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: Type of the ICMP message being sent
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: An optional project of the security group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: protocol
        in: query
        description: TCP is default. UDP is the other supported protocol
        schema:
          type: string
          maxLength: 255
      - name: securitygroupid
        in: query
        description: The ID of the security group. Mutually exclusive with securityGroupName parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createSecurityGroup
        - updateSecurityGroup
      - name: securitygroupname
        in: query
        description: The name of the security group. Mutually exclusive with securityGroupId parameter
        schema:
          type: string
          maxLength: 255
      - name: startport
        in: query
        description: Start port for this egress rule
        schema:
          type: integer
          format: int32
      - name: usersecuritygrouplist
        in: query
        description: User to security group mapping. Map parameter. CloudStack expects it index-encoded as `usersecuritygrouplist[0].key=k&usersecuritygrouplist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `authorizeSecurityGroupEgress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  authorizesecuritygroupegressresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - authorizesecuritygroupegressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  authorizesecuritygroupegressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - authorizesecuritygroupegressresponse
      x-cloudstack-command: authorizeSecurityGroupEgress
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - authorizeSecurityGroupIngress
      x-cloudstack-jobresult-schema: '#/components/schemas/AuthorizeSecurityGroupEgressResult'
  /authorizeSecurityGroupIngress:
    get:
      operationId: authorizeSecurityGroupIngress
      summary: Authorizes a particular ingress rule for this security group
      description: |-
        Authorizes a particular ingress rule for this security group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SecurityGroupIngress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: authorizeSecurityGroupIngress
          default: authorizeSecurityGroupIngress
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: An optional account for the security group. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: The cidr list associated. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: domainid
        in: query
        description: An optional domainId for the security group. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: endport
        in: query
        description: End port for this ingress rule
        schema:
          type: integer
          format: int32
      - name: icmpcode
        in: query
        description: Error code for this icmp message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: Type of the icmp message being sent
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: An optional project of the security group
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: protocol
        in: query
        description: The protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number (see /etc/protocols). ALL is default.
        schema:
          type: string
          maxLength: 255
      - name: securitygroupid
        in: query
        description: The ID of the security group. Mutually exclusive with securityGroupName parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: securitygroupname
        in: query
        description: The name of the security group. Mutually exclusive with securityGroupId parameter
        schema:
          type: string
          maxLength: 255
      - name: startport
        in: query
        description: Start port for this ingress rule
        schema:
          type: integer
          format: int32
      - name: usersecuritygrouplist
        in: query
        description: User to security group mapping. Map parameter. CloudStack expects it index-encoded as `usersecuritygrouplist[0].key=k&usersecuritygrouplist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `authorizeSecurityGroupIngress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  authorizesecuritygroupingressresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - authorizesecuritygroupingressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  authorizesecuritygroupingressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - authorizesecuritygroupingressresponse
      x-cloudstack-command: authorizeSecurityGroupIngress
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/AuthorizeSecurityGroupEgressResult'
  /cancelHostAsDegraded:
    get:
      operationId: cancelHostAsDegraded
      summary: Cancel host status from 'Degraded'.
      description: |-
        Cancel host status from 'Degraded'. Host will transit back to status 'Enabled'.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - HostAsDegraded
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cancelHostAsDegraded
          default: cancelHostAsDegraded
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Host ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - cancelHostAsDegraded
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `cancelHostAsDegraded`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelhostasdegradedresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - cancelhostasdegradedresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelhostasdegradedresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - cancelhostasdegradedresponse
      x-cloudstack-command: cancelHostAsDegraded
      x-cloudstack-async: true
      x-cloudstack-since: 4.16.0.0
      x-cloudstack-related:
      - addBaremetalHost
      - declareHostAsDegraded
      - listHosts
      - reconnectHost
      x-cloudstack-jobresult-schema: '#/components/schemas/Host'
  /cancelHostMaintenance:
    get:
      operationId: cancelHostMaintenance
      summary: Cancels host maintenance.
      description: |-
        Cancels host maintenance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - HostMaintenance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cancelHostMaintenance
          default: cancelHostMaintenance
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The host ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `cancelHostMaintenance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelhostmaintenanceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - cancelhostmaintenanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelhostmaintenanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - cancelhostmaintenanceresponse
      x-cloudstack-command: cancelHostMaintenance
      x-cloudstack-async: true
      x-cloudstack-related:
      - addBaremetalHost
      - addHost
      - cancelHostAsDegraded
      - declareHostAsDegraded
      - listHosts
      - reconnectHost
      x-cloudstack-jobresult-schema: '#/components/schemas/Host'
  /cancelMaintenance:
    get:
      operationId: cancelMaintenance
      summary: Cancels maintenance of the management server
      tags:
      - Maintenance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cancelMaintenance
          default: cancelMaintenance
      - $ref: '#/components/parameters/response'
      - name: managementserverid
        in: query
        description: The UUID of the management server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listManagementServers
      - name: rebalance
        in: query
        description: Rebalance agents (applicable for indirect agents, ensure the settings 'host' and 'indirect.agent.lb.algorithm' are properly configured) after cancelling maintenance, default is true
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `cancelMaintenance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelmaintenanceresponse:
                    oneOf:
                    - &id032
                      $ref: '#/components/schemas/CancelMaintenanceResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id032
                        - type: array
                          items: *id032
                required:
                - cancelmaintenanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelmaintenanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - cancelmaintenanceresponse
      x-cloudstack-command: cancelMaintenance
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - cancelShutdown
      - prepareForMaintenance
      - prepareForShutdown
      - readyForShutdown
  /cancelShutdown:
    get:
      operationId: cancelShutdown
      summary: Cancels a triggered shutdown
      tags:
      - Shutdown
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cancelShutdown
          default: cancelShutdown
      - $ref: '#/components/parameters/response'
      - name: managementserverid
        in: query
        description: The UUID of the management server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listManagementServers
      responses:
        '200':
          description: Successful invocation of `cancelShutdown`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelshutdownresponse:
                    oneOf:
                    - &id033
                      $ref: '#/components/schemas/CancelMaintenanceResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id033
                        - type: array
                          items: *id033
                required:
                - cancelshutdownresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelshutdownresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - cancelshutdownresponse
      x-cloudstack-command: cancelShutdown
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - prepareForShutdown
      - readyForShutdown
  /cancelStorageMaintenance:
    get:
      operationId: cancelStorageMaintenance
      summary: Cancels maintenance for primary storage
      description: |-
        Cancels maintenance for primary storage

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StorageMaintenance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cancelStorageMaintenance
          default: cancelStorageMaintenance
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The primary storage ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
      responses:
        '200':
          description: Successful invocation of `cancelStorageMaintenance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelstoragemaintenanceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - cancelstoragemaintenanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cancelstoragemaintenanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - cancelstoragemaintenanceresponse
      x-cloudstack-command: cancelStorageMaintenance
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/StoragePool'
  /changeBgpPeersForNetwork:
    get:
      operationId: changeBgpPeersForNetwork
      summary: Change the BGP peers for a network.
      description: |-
        Change the BGP peers for a network.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeBgpPeersForNetwork
          default: changeBgpPeersForNetwork
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: UUID of the network which the Bgp Peers are associated to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: bgppeerids
        in: query
        description: Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - changeBgpPeersForNetwork
        - changeBgpPeersForVpc
        - createBgpPeer
        - dedicateBgpPeer
        - listBgpPeers
        - releaseBgpPeer
        - updateBgpPeer
      responses:
        '200':
          description: Successful invocation of `changeBgpPeersForNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changebgppeersfornetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - changebgppeersfornetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changebgppeersfornetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changebgppeersfornetworkresponse
      x-cloudstack-command: changeBgpPeersForNetwork
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - changeBgpPeersForVpc
      - createBgpPeer
      - dedicateBgpPeer
      - listBgpPeers
      - releaseBgpPeer
      - updateBgpPeer
      x-cloudstack-jobresult-schema: '#/components/schemas/BgpPeer'
  /changeBgpPeersForVpc:
    get:
      operationId: changeBgpPeersForVpc
      summary: Change the BGP peers for a VPC.
      description: |-
        Change the BGP peers for a VPC.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BgpPeersForVpc
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeBgpPeersForVpc
          default: changeBgpPeersForVpc
      - $ref: '#/components/parameters/response'
      - name: vpcid
        in: query
        description: UUID of the VPC which the Bgp Peers are associated to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      - name: bgppeerids
        in: query
        description: Ids of the Bgp Peer. If it is empty, all BGP peers will be unlinked. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - changeBgpPeersForVpc
        - createBgpPeer
        - dedicateBgpPeer
        - listBgpPeers
        - releaseBgpPeer
        - updateBgpPeer
      responses:
        '200':
          description: Successful invocation of `changeBgpPeersForVpc`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changebgppeersforvpcresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - changebgppeersforvpcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changebgppeersforvpcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changebgppeersforvpcresponse
      x-cloudstack-command: changeBgpPeersForVpc
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createBgpPeer
      - dedicateBgpPeer
      - listBgpPeers
      - releaseBgpPeer
      - updateBgpPeer
      x-cloudstack-jobresult-schema: '#/components/schemas/BgpPeer'
  /changeOfferingForVolume:
    get:
      operationId: changeOfferingForVolume
      summary: Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering
      description: |-
        Change disk offering of the volume and also an option to auto migrate if required to apply the new disk offering

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeOfferingForVolume
          default: changeOfferingForVolume
      - $ref: '#/components/parameters/response'
      - name: diskofferingid
        in: query
        description: New disk offering ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
        - listDiskOfferings
      - name: id
        in: query
        description: The ID of the volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: automigrate
        in: query
        description: Flag for automatic migration of the volume with new disk offering whenever migration is required to apply the offering
        schema:
          type: boolean
      - name: maxiops
        in: query
        description: New maximum number of IOPS for the custom disk offering
        schema:
          type: integer
          format: int64
      - name: miniops
        in: query
        description: New minimum number of IOPS for the custom disk offering
        schema:
          type: integer
          format: int64
      - name: shrinkok
        in: query
        description: Verify OK to Shrink
        schema:
          type: boolean
      - name: size
        in: query
        description: New volume size in GB for the custom disk offering
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `changeOfferingForVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeofferingforvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - changeofferingforvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeofferingforvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changeofferingforvolumeresponse
      x-cloudstack-command: changeOfferingForVolume
      x-cloudstack-async: true
      x-cloudstack-since: '4.17'
      x-cloudstack-related:
      - assignVolume
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /changeOutOfBandManagementPassword:
    get:
      operationId: changeOutOfBandManagementPassword
      summary: Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password
      description: |-
        Changes out-of-band management interface password on the host and updates the interface configuration in CloudStack if the operation succeeds, else reverts the old password

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - OutOfBandManagementPassword
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeOutOfBandManagementPassword
          default: changeOutOfBandManagementPassword
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: The ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: password
        in: query
        description: The new host management interface password of maximum length 16, if none is provided a random password would be used
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `changeOutOfBandManagementPassword`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeoutofbandmanagementpasswordresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - changeoutofbandmanagementpasswordresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeoutofbandmanagementpasswordresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changeoutofbandmanagementpasswordresponse
      x-cloudstack-command: changeOutOfBandManagementPassword
      x-cloudstack-async: true
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - enableOutOfBandManagementForHost
      x-cloudstack-jobresult-schema: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
  /changeServiceForRouter:
    get:
      operationId: changeServiceForRouter
      summary: Upgrades domain router to a new service offering
      tags:
      - Router
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeServiceForRouter
          default: changeServiceForRouter
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the router
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - listInternalLoadBalancerVMs
        - listRouters
      - name: serviceofferingid
        in: query
        description: The service offering ID to apply to the domain router
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      responses:
        '200':
          description: Successful invocation of `changeServiceForRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeserviceforrouterresponse:
                    oneOf:
                    - &id034
                      $ref: '#/components/schemas/Router'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id034
                        - type: array
                          items: *id034
                required:
                - changeserviceforrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeserviceforrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changeserviceforrouterresponse
      x-cloudstack-command: changeServiceForRouter
      x-cloudstack-async: false
      x-cloudstack-related:
      - listInternalLoadBalancerVMs
      - listRouters
  /changeServiceForSystemVm:
    get:
      operationId: changeServiceForSystemVm
      summary: Changes the service offering for a system vm (console proxy or secondary storage).
      description: Changes the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeServiceForSystemVm
          default: changeServiceForSystemVm
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the System VM
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForSystemVm
        - startSystemVm
      - name: serviceofferingid
        in: query
        description: The service offering ID to apply to the System VM
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: details
        in: query
        description: Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `changeServiceForSystemVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeserviceforsystemvmresponse:
                    oneOf:
                    - &id035
                      $ref: '#/components/schemas/SystemVm'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id035
                        - type: array
                          items: *id035
                required:
                - changeserviceforsystemvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeserviceforsystemvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changeserviceforsystemvmresponse
      x-cloudstack-command: changeServiceForSystemVm
      x-cloudstack-async: false
      x-cloudstack-related:
      - startSystemVm
  /changeServiceForVirtualMachine:
    get:
      operationId: changeServiceForVirtualMachine
      summary: (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for an Instance.
      description: (This API is deprecated, use scaleVirtualMachine API)Changes the service offering for an Instance. The Instance must be in a "Stopped" state for this command to take effect.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeServiceForVirtualMachine
          default: changeServiceForVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: serviceofferingid
        in: query
        description: The service offering ID to apply to the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: automigrate
        in: query
        description: Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering
        schema:
          type: boolean
        x-cloudstack-since: '4.17'
      - name: details
        in: query
        description: Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: maxiops
        in: query
        description: New maximum number of IOPS for the custom disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.17'
      - name: miniops
        in: query
        description: New minimum number of IOPS for the custom disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.17'
      - name: shrinkok
        in: query
        description: Verify OK to Shrink
        schema:
          type: boolean
        x-cloudstack-since: '4.17'
      responses:
        '200':
          description: Successful invocation of `changeServiceForVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeserviceforvirtualmachineresponse:
                    oneOf:
                    - &id036
                      $ref: '#/components/schemas/VirtualMachine'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id036
                        - type: array
                          items: *id036
                required:
                - changeserviceforvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changeserviceforvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changeserviceforvirtualmachineresponse
      x-cloudstack-command: changeServiceForVirtualMachine
      x-cloudstack-async: false
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
  /changeSharedFileSystemDiskOffering:
    get:
      operationId: changeSharedFileSystemDiskOffering
      summary: Change Disk offering of a Shared FileSystem
      description: |-
        Change Disk offering of a Shared FileSystem

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DiskOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeSharedFileSystemDiskOffering
          default: changeSharedFileSystemDiskOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the shared filesystem
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
      - name: diskofferingid
        in: query
        description: the disk offering to use for the underlying storage
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: maxiops
        in: query
        description: max iops
        schema:
          type: integer
          format: int64
      - name: miniops
        in: query
        description: min iops
        schema:
          type: integer
          format: int64
      - name: size
        in: query
        description: the size of the shared filesystem in GiB
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `changeSharedFileSystemDiskOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changesharedfilesystemdiskofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - changesharedfilesystemdiskofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changesharedfilesystemdiskofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changesharedfilesystemdiskofferingresponse
      x-cloudstack-command: changeSharedFileSystemDiskOffering
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SharedFileSystem'
  /changeSharedFileSystemServiceOffering:
    get:
      operationId: changeSharedFileSystemServiceOffering
      summary: Change Service offering of a Shared FileSystem
      description: |-
        Change Service offering of a Shared FileSystem

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ServiceOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeSharedFileSystemServiceOffering
          default: changeSharedFileSystemServiceOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the shared filesystem
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
        - changeSharedFileSystemServiceOffering
        - listSharedFileSystems
      - name: serviceofferingid
        in: query
        description: the offering to use for the shared filesystem instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      responses:
        '200':
          description: Successful invocation of `changeSharedFileSystemServiceOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changesharedfilesystemserviceofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - changesharedfilesystemserviceofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changesharedfilesystemserviceofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changesharedfilesystemserviceofferingresponse
      x-cloudstack-command: changeSharedFileSystemServiceOffering
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - changeSharedFileSystemDiskOffering
      - listSharedFileSystems
      x-cloudstack-jobresult-schema: '#/components/schemas/SharedFileSystem'
  /changeStoragePoolScope:
    get:
      operationId: changeStoragePoolScope
      summary: 'Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary.'
      description: |-
        Changes the scope of a storage pool when the pool is in Disabled state.This feature is officially tested and supported for Hypervisors: KVM and VMware, Protocols: NFS and Ceph, and Storage Provider: DefaultPrimary. There might be extra steps involved to make this work for other hypervisors and storage options.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StoragePoolScope
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: changeStoragePoolScope
          default: changeStoragePoolScope
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the Id of the storage pool
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: scope
        in: query
        description: 'the scope of the storage: cluster or zone'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: clusterid
        in: query
        description: the Id of the cluster to use if scope is being set to Cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `changeStoragePoolScope`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changestoragepoolscoperesponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - changestoragepoolscoperesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  changestoragepoolscoperesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - changestoragepoolscoperesponse
      x-cloudstack-command: changeStoragePoolScope
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.1
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /checkVolume:
    get:
      operationId: checkVolume
      summary: Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only
      description: |-
        Check the volume for any errors or leaks and also repairs when repair parameter is passed, this is currently supported for KVM only

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: checkVolume
          default: checkVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - checkVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: repair
        in: query
        description: parameter to repair the volume, leaks or all are the possible values
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `checkVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  checkvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - checkvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  checkvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - checkvolumeresponse
      x-cloudstack-command: checkVolume
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.1
      x-cloudstack-related:
      - assignVolume
      - attachVolume
      - changeOfferingForVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /cleanVMReservations:
    get:
      operationId: cleanVMReservations
      summary: Cleanups Instance reservations in the database.
      description: |-
        Cleanups Instance reservations in the database.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - CleanVMReservation
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cleanVMReservations
          default: cleanVMReservations
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `cleanVMReservations`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cleanvmreservationsresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - cleanvmreservationsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cleanvmreservationsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - cleanvmreservationsresponse
      x-cloudstack-command: cleanVMReservations
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /cloneBackupOffering:
    get:
      operationId: cloneBackupOffering
      summary: Clones a backup offering from an existing offering
      description: |-
        Clones a backup offering from an existing offering

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BackupOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cloneBackupOffering
          default: cloneBackupOffering
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the cloned offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: sourceofferingid
        in: query
        description: The ID of the source backup offering to clone from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneBackupOffering
        - createBackupOffering
        - listBackupOfferings
        - updateBackupOffering
      - name: allowuserdrivenbackups
        in: query
        description: Whether users are allowed to create adhoc backups and backup schedules
        schema:
          type: boolean
      - name: description
        in: query
        description: The description of the cloned offering
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: the ID of the containing domain(s) as comma separated string, public for public offerings
        schema:
          type: string
          maxLength: 4096
      - name: externalid
        in: query
        description: The backup offering ID (from backup provider side)
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `cloneBackupOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clonebackupofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - clonebackupofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clonebackupofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - clonebackupofferingresponse
      x-cloudstack-command: cloneBackupOffering
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createBackupOffering
      - listBackupOfferings
      - updateBackupOffering
      x-cloudstack-jobresult-schema: '#/components/schemas/BackupOffering'
  /cloneDiskOffering:
    get:
      operationId: cloneDiskOffering
      summary: Clones a disk offering.
      description: Clones a disk offering. All parameters from createDiskOffering are available. If not specified, values will be copied from the source offering.
      tags:
      - DiskOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cloneDiskOffering
          default: cloneDiskOffering
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the disk offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: sourceofferingid
        in: query
        description: The ID of the source disk offering to clone from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
      - name: bytesreadrate
        in: query
        description: Bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: bytesreadratemax
        in: query
        description: Burst bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: bytesreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: byteswriterate
        in: query
        description: Bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: byteswriteratemax
        in: query
        description: Burst bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: byteswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: cachemode
        in: query
        description: The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.14'
      - name: customized
        in: query
        description: Whether disk offering size is custom or not
        schema:
          type: boolean
      - name: customizediops
        in: query
        description: Whether disk offering IOPS is custom or not
        schema:
          type: boolean
      - name: details
        in: query
        description: Details to specify disk offering parameters. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.16'
      - name: disksize
        in: query
        description: Size of the disk offering in GB (1GB = 1,073,741,824 bytes)
        schema:
          type: integer
          format: int64
      - name: disksizestrictness
        in: query
        description: To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed
        schema:
          type: boolean
        x-cloudstack-since: '4.17'
      - name: displayoffering
        in: query
        description: An optional field, whether to display the offering to the end user or not.
        schema:
          type: boolean
      - name: displaytext
        in: query
        description: An alternate display text of the disk offering, defaults to 'name'.
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: The ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: encrypt
        in: query
        description: Volumes using this offering should be encrypted
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: hypervisorsnapshotreserve
        in: query
        description: Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
        schema:
          type: integer
          format: int32
      - name: iopsreadrate
        in: query
        description: I/O requests read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopsreadratemax
        in: query
        description: Burst requests read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopsreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: iopswriterate
        in: query
        description: I/O requests write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopswriteratemax
        in: query
        description: Burst I/O requests write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: maxiops
        in: query
        description: Max IOPS of the disk offering
        schema:
          type: integer
          format: int64
      - name: miniops
        in: query
        description: Min IOPS of the disk offering
        schema:
          type: integer
          format: int64
      - name: provisioningtype
        in: query
        description: Provisioning type used to create volumes. Valid values are thin, sparse, fat.
        schema:
          type: string
          maxLength: 255
      - name: storagepolicy
        in: query
        description: Name of the storage policy defined at vCenter, this is applicable only for VMware
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.15'
        x-cloudstack-related:
        - listVsphereStoragePolicies
      - name: storagetype
        in: query
        description: The storage type of the disk offering. Values are local and shared.
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: Tags for the disk offering
        schema:
          type: string
          maxLength: 4096
      - name: zoneid
        in: query
        description: The ID of the containing zone(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `cloneDiskOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clonediskofferingresponse:
                    oneOf:
                    - &id037
                      $ref: '#/components/schemas/DiskOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id037
                        - type: array
                          items: *id037
                required:
                - clonediskofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clonediskofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - clonediskofferingresponse
      x-cloudstack-command: cloneDiskOffering
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createDiskOffering
  /cloneNetworkOffering:
    get:
      operationId: cloneNetworkOffering
      summary: Clones a network offering.
      description: Clones a network offering. All parameters are copied from the source offering unless explicitly overridden. Use 'addServices' and 'dropServices' to modify the service list without respecifying everything.
      tags:
      - NetworkOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cloneNetworkOffering
          default: cloneNetworkOffering
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the network offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: sourceofferingid
        in: query
        description: The ID of the source network offering to clone from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneNetworkOffering
        - createNetworkOffering
        - listNetworkOfferings
        - updateNetworkOffering
      - name: addservices
        in: query
        description: Services to add to the cloned offering (in addition to source offering services). If specified along with 'supportedservices', this parameter is ignored. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: availability
        in: query
        description: The availability of network offering. The default value is Optional.  Another value is Required, which will make it as the default network offering for new networks
        schema:
          type: string
          maxLength: 255
      - name: conservemode
        in: query
        description: True if the network offering is IP conserve mode enabled
        schema:
          type: boolean
      - name: details
        in: query
        description: Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.2.0
      - name: displaytext
        in: query
        description: The display text of the network offering, defaults to the value of 'name'.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: dropservices
        in: query
        description: Services to remove from the cloned offering (that exist in source offering). If specified along with 'supportedservices', this parameter is ignored. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: egressdefaultpolicy
        in: query
        description: True if guest network default egress policy is allow; false if default egress policy is deny
        schema:
          type: boolean
      - name: enable
        in: query
        description: Set to true if the offering is to be enabled during creation. Default is false
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: fornsx
        in: query
        description: true if network offering is meant to be used for NSX, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: fortungsten
        in: query
        description: True if network offering is meant to be used for Tungsten-Fabric, false otherwise.
        schema:
          type: boolean
      - name: forvpc
        in: query
        description: True if network offering is meant to be used for VPC, false otherwise.
        schema:
          type: boolean
      - name: guestiptype
        in: query
        description: 'Guest type of the network offering: Shared or Isolated'
        schema:
          type: string
          maxLength: 255
      - name: internetprotocol
        in: query
        description: The internet protocol of network offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create a network offering that supports both IPv4 and IPv6
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.17.0
      - name: ispersistent
        in: query
        description: True if network offering supports persistent networks; defaulted to false if not specified
        schema:
          type: boolean
      - name: keepaliveenabled
        in: query
        description: If true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.
        schema:
          type: boolean
      - name: maxconnections
        in: query
        description: Maximum number of concurrent connections supported by the Network offering
        schema:
          type: integer
          format: int32
      - name: networkmode
        in: query
        description: 'Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: networkrate
        in: query
        description: Data transfer rate in megabits per second allowed
        schema:
          type: integer
          format: int32
      - name: nsxsupportlb
        in: query
        description: True if network offering for NSX network offering supports Load balancer service.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: nsxsupportsinternallb
        in: query
        description: True if network offering for NSX network offering supports Internal Load balancer service.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: provider
        in: query
        description: Name of the provider providing the service
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: routingmode
        in: query
        description: 'the routing mode for the network offering. Supported types are: Static or Dynamic.'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: servicecapabilitylist
        in: query
        description: Desired service capabilities as part of network offering. Map parameter. CloudStack expects it index-encoded as `servicecapabilitylist[0].key=k&servicecapabilitylist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: serviceofferingid
        in: query
        description: The service offering ID used by virtual router provider
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneServiceOffering
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: serviceproviderlist
        in: query
        description: Provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network. Map parameter. CloudStack expects it index-encoded as `serviceproviderlist[0].key=k&serviceproviderlist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: specifyasnumber
        in: query
        description: true if network offering supports choosing AS number
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: specifyipranges
        in: query
        description: True if network offering supports specifying ip ranges; defaulted to false if not specified
        schema:
          type: boolean
      - name: specifyvlan
        in: query
        description: True if network offering supports VLANs
        schema:
          type: boolean
      - name: supportedservices
        in: query
        description: Services supported by the network offering. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: tags
        in: query
        description: The tags for the network offering.
        schema:
          type: string
          maxLength: 4096
      - name: traffictype
        in: query
        description: The traffic type for the network offering. Supported type in current release is GUEST only
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of the containing zone(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `cloneNetworkOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clonenetworkofferingresponse:
                    oneOf:
                    - &id038
                      $ref: '#/components/schemas/NetworkOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id038
                        - type: array
                          items: *id038
                required:
                - clonenetworkofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clonenetworkofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - clonenetworkofferingresponse
      x-cloudstack-command: cloneNetworkOffering
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createNetworkOffering
      - listNetworkOfferings
      - updateNetworkOffering
  /cloneServiceOffering:
    get:
      operationId: cloneServiceOffering
      summary: Clones a service offering.
      description: Clones a service offering. All parameters from createServiceOffering are available. If not specified, values will be copied from the source offering.
      tags:
      - ServiceOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cloneServiceOffering
          default: cloneServiceOffering
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the service offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: sourceofferingid
        in: query
        description: The ID of the source service offering to clone from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneServiceOffering
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: bytesreadrate
        in: query
        description: Bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: bytesreadratemax
        in: query
        description: Burst bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: bytesreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: byteswriterate
        in: query
        description: Bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: byteswriteratemax
        in: query
        description: Burst bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: byteswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: cachemode
        in: query
        description: The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.14'
      - name: cpunumber
        in: query
        description: The CPU number of the service offering
        schema:
          type: integer
          format: int32
      - name: cpuspeed
        in: query
        description: |-
          For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.
          For the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the Instance will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest Instances. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.
        schema:
          type: integer
          format: int32
      - name: customized
        in: query
        description: Whether service offering size is custom or not
        schema:
          type: boolean
        x-cloudstack-since: '4.13'
      - name: customizediops
        in: query
        description: Whether compute offering iops is custom or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: deploymentplanner
        in: query
        description: The deployment planner heuristics used to deploy an Instance of this offering. If null, value of global config vm.deployment.planner is used
        schema:
          type: string
          maxLength: 255
      - name: diskofferingid
        in: query
        description: The ID of the disk offering to which service offering should be mapped
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
        - listDiskOfferings
      - name: diskofferingstrictness
        in: query
        description: True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed
        schema:
          type: boolean
        x-cloudstack-since: '4.17'
      - name: displaytext
        in: query
        description: The display text of the service offering, defaults to 'name'.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: dynamicscalingenabled
        in: query
        description: True if Instance needs to be dynamically scalable of cpu or memory
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: encryptroot
        in: query
        description: VMs using this offering require root volume encryption
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: gpucount
        in: query
        description: Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.21'
      - name: gpudisplay
        in: query
        description: Whether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.
        schema:
          type: boolean
        x-cloudstack-since: '4.21'
      - name: hosttags
        in: query
        description: The host tag for this service offering.
        schema:
          type: string
          maxLength: 255
      - name: hypervisorsnapshotreserve
        in: query
        description: Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.4'
      - name: iopsreadrate
        in: query
        description: I/O requests read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopsreadratemax
        in: query
        description: Burst requests read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopsreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: iopswriterate
        in: query
        description: I/O requests write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopswriteratemax
        in: query
        description: Burst io requests write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: issystem
        in: query
        description: Is this a system vm offering
        schema:
          type: boolean
      - name: isvolatile
        in: query
        description: True if the Instance needs to be volatile so that on every reboot, the original root disk is detached, then destroyed and a fresh root disk is created and attached to the Instance
        schema:
          type: boolean
      - name: leaseduration
        in: query
        description: Number of days instance is leased for.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.21.0
      - name: leaseexpiryaction
        in: query
        description: Lease expiry action, valid values are STOP and DESTROY
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: limitcpuuse
        in: query
        description: Restrict the CPU usage to committed service offering
        schema:
          type: boolean
      - name: maxcpunumber
        in: query
        description: The maximum number of CPUs to be set with Custom Computer Offering
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.13'
      - name: maxiops
        in: query
        description: Max iops of the compute offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.4'
      - name: maxmemory
        in: query
        description: The maximum memory size of the custom service offering in MB
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.13'
      - name: memory
        in: query
        description: The total memory of the service offering in MB
        schema:
          type: integer
          format: int32
      - name: mincpunumber
        in: query
        description: The minimum number of CPUs to be set with Custom Computer Offering
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.13'
      - name: miniops
        in: query
        description: Min iops of the compute offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.4'
      - name: minmemory
        in: query
        description: The minimum memory size of the custom service offering in MB
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.13'
      - name: networkrate
        in: query
        description: Data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype
        schema:
          type: integer
          format: int32
      - name: offerha
        in: query
        description: The HA for the service offering
        schema:
          type: boolean
      - name: provisioningtype
        in: query
        description: Provisioning type used to create volumes. Valid values are thin, sparse, fat.
        schema:
          type: string
          maxLength: 255
      - name: purgeresources
        in: query
        description: Whether to cleanup instance and its associated resource from database upon expunge of the instance
        schema:
          type: boolean
        x-cloudstack-since: '4.20'
      - name: rootdisksize
        in: query
        description: The Root disk size in GB.
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: serviceofferingdetails
        in: query
        description: Details for planner, used to store specific parameters. Map parameter. CloudStack expects it index-encoded as `serviceofferingdetails[0].key=k&serviceofferingdetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: storagepolicy
        in: query
        description: Name of the storage policy defined at vCenter, this is applicable only for VMware
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.15'
        x-cloudstack-related:
        - listVsphereStoragePolicies
      - name: storagetype
        in: query
        description: The storage type of the service offering. Values are local and shared.
        schema:
          type: string
          maxLength: 255
      - name: systemvmtype
        in: query
        description: The system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: The tags for this service offering.
        schema:
          type: string
          maxLength: 255
      - name: vgpuprofileid
        in: query
        description: the ID of the vGPU profile to which service offering should be mapped
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.21'
        x-cloudstack-related:
        - createVgpuProfile
        - listVgpuProfiles
        - updateVgpuProfile
      - name: zoneid
        in: query
        description: The ID of the containing zone(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `cloneServiceOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cloneserviceofferingresponse:
                    oneOf:
                    - &id039
                      $ref: '#/components/schemas/ServiceOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id039
                        - type: array
                          items: *id039
                required:
                - cloneserviceofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cloneserviceofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - cloneserviceofferingresponse
      x-cloudstack-command: cloneServiceOffering
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createServiceOffering
      - listServiceOfferings
      - updateServiceOffering
  /cloneVPCOffering:
    get:
      operationId: cloneVPCOffering
      summary: Clones an existing VPC offering.
      description: |-
        Clones an existing VPC offering. All parameters are copied from the source offering unless explicitly overridden. Use 'addServices' and 'dropServices' to modify the service list without respecifying everything.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPCOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cloneVPCOffering
          default: cloneVPCOffering
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the VPC offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: sourceofferingid
        in: query
        description: The ID of the source VPC offering to clone from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneVPCOffering
        - updateVPCOffering
      - name: addservices
        in: query
        description: Services to add to the cloned offering (in addition to source offering services). If specified along with 'supportedservices', this parameter is ignored. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: conservemode
        in: query
        description: True if the VPC offering is IP conserve mode enabled, allowing public IPs to be used across multiple VPC tiers. Default value is false
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: displaytext
        in: query
        description: The display text of the VPC offering, defaults to the 'name'
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listDomains
      - name: dropservices
        in: query
        description: Services to remove from the cloned offering (that exist in source offering). If specified along with 'supportedservices', this parameter is ignored. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: enable
        in: query
        description: Set to true if the offering is to be enabled during creation. Default is false
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: fornsx
        in: query
        description: true if network offering is meant to be used for NSX, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: internetprotocol
        in: query
        description: The internet protocol of the offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create an offering that supports both IPv4 and IPv6
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.17.0
      - name: networkmode
        in: query
        description: 'Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: nsxsupportlb
        in: query
        description: true if network offering for NSX VPC offering supports Load balancer service.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: provider
        in: query
        description: Name of the provider providing the service
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: routingmode
        in: query
        description: 'the routing mode for the VPC offering. Supported types are: Static or Dynamic.'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: servicecapabilitylist
        in: query
        description: Desired service capabilities as part of VPC offering. Map parameter. CloudStack expects it index-encoded as `servicecapabilitylist[0].key=k&servicecapabilitylist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.4'
      - name: serviceofferingid
        in: query
        description: The ID of the service offering for the VPC router appliance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: serviceproviderlist
        in: query
        description: Provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network. Map parameter. CloudStack expects it index-encoded as `serviceproviderlist[0].key=k&serviceproviderlist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: specifyasnumber
        in: query
        description: true if the VPC offering supports choosing AS number
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: supportedservices
        in: query
        description: Services supported by the VPC offering. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: zoneid
        in: query
        description: The ID of the containing zone(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `cloneVPCOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clonevpcofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - clonevpcofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clonevpcofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - clonevpcofferingresponse
      x-cloudstack-command: cloneVPCOffering
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - updateVPCOffering
      x-cloudstack-jobresult-schema: '#/components/schemas/VPCOffering'
  /cloudianIsEnabled:
    get:
      operationId: cloudianIsEnabled
      summary: Checks if the Cloudian Connector is enabled
      tags:
      - CloudianIsEnabled
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: cloudianIsEnabled
          default: cloudianIsEnabled
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `cloudianIsEnabled`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cloudianisenabledresponse:
                    oneOf:
                    - &id040
                      $ref: '#/components/schemas/CloudianIsEnabled'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id040
                        - type: array
                          items: *id040
                required:
                - cloudianisenabledresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  cloudianisenabledresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - cloudianisenabledresponse
      x-cloudstack-command: cloudianIsEnabled
      x-cloudstack-async: false
      x-cloudstack-since: 4.11.0
  /configTungstenFabricService:
    get:
      operationId: configTungstenFabricService
      summary: Config Tungsten-Fabric service
      tags:
      - ConfigTungstenFabricService
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configTungstenFabricService
          default: configTungstenFabricService
      - $ref: '#/components/parameters/response'
      - name: physicalnetworkid
        in: query
        description: The ID of physical network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `configTungstenFabricService`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configtungstenfabricserviceresponse:
                    oneOf:
                    - &id041
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id041
                        - type: array
                          items: *id041
                required:
                - configtungstenfabricserviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configtungstenfabricserviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configtungstenfabricserviceresponse
      x-cloudstack-command: configTungstenFabricService
      x-cloudstack-async: false
  /configureHAForHost:
    get:
      operationId: configureHAForHost
      summary: Configures HA for a host
      description: |-
        Configures HA for a host

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - HAForHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configureHAForHost
          default: configureHAForHost
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - cancelHostAsDegraded
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: provider
        in: query
        description: HA provider
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `configureHAForHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurehaforhostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - configurehaforhostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurehaforhostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configurehaforhostresponse
      x-cloudstack-command: configureHAForHost
      x-cloudstack-async: true
      x-cloudstack-since: '4.11'
      x-cloudstack-related:
      - disableHAForHost
      - enableHAForHost
      x-cloudstack-jobresult-schema: '#/components/schemas/HAForHost'
  /configureInternalLoadBalancerElement:
    get:
      operationId: configureInternalLoadBalancerElement
      summary: Configures an Internal Load Balancer element.
      description: |-
        Configures an Internal Load Balancer element.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - InternalLoadBalancerElement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configureInternalLoadBalancerElement
          default: configureInternalLoadBalancerElement
      - $ref: '#/components/parameters/response'
      - name: enabled
        in: query
        description: Enables/Disables the Internal Load Balancer element
        required: true
        schema:
          type: boolean
      - name: id
        in: query
        description: The ID of the internal lb provider
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - configureInternalLoadBalancerElement
        - listInternalLoadBalancerElements
      responses:
        '200':
          description: Successful invocation of `configureInternalLoadBalancerElement`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configureinternalloadbalancerelementresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - configureinternalloadbalancerelementresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configureinternalloadbalancerelementresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configureinternalloadbalancerelementresponse
      x-cloudstack-command: configureInternalLoadBalancerElement
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - listInternalLoadBalancerElements
      x-cloudstack-jobresult-schema: '#/components/schemas/InternalLoadBalancerElement'
  /configureNetscalerLoadBalancer:
    get:
      operationId: configureNetscalerLoadBalancer
      summary: Configures a netscaler load balancer device
      description: |-
        Configures a netscaler load balancer device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetscalerLoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configureNetscalerLoadBalancer
          default: configureNetscalerLoadBalancer
      - $ref: '#/components/parameters/response'
      - name: lbdeviceid
        in: query
        description: Netscaler load balancer device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetscalerLoadBalancer
        - configureNetscalerLoadBalancer
        - deployNetscalerVpx
        - registerNetscalerControlCenter
      - name: inline
        in: query
        description: True if netscaler load balancer is intended to be used in in-line with firewall, false if netscaler load balancer will side-by-side with firewall
        schema:
          type: boolean
      - name: lbdevicecapacity
        in: query
        description: Capacity of the device, Capacity will be interpreted as number of networks device can handle
        schema:
          type: integer
          format: int64
      - name: lbdevicededicated
        in: query
        description: True if this netscaler device to dedicated for a account, false if the netscaler device will be shared by multiple accounts
        schema:
          type: boolean
      - name: podids
        in: query
        description: Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createManagementNetworkIpRange
      responses:
        '200':
          description: Successful invocation of `configureNetscalerLoadBalancer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurenetscalerloadbalancerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - configurenetscalerloadbalancerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurenetscalerloadbalancerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configurenetscalerloadbalancerresponse
      x-cloudstack-command: configureNetscalerLoadBalancer
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNetscalerLoadBalancer
      - deployNetscalerVpx
      - registerNetscalerControlCenter
      x-cloudstack-jobresult-schema: '#/components/schemas/NetscalerLoadBalancer'
  /configureOutOfBandManagement:
    get:
      operationId: configureOutOfBandManagement
      summary: Configures a host's out-of-band management interface
      tags:
      - OutOfBandManagement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configureOutOfBandManagement
          default: configureOutOfBandManagement
      - $ref: '#/components/parameters/response'
      - name: address
        in: query
        description: The host management interface IP address
        required: true
        schema:
          type: string
          maxLength: 255
      - name: driver
        in: query
        description: 'The host management interface driver, for example: ipmitool'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hostid
        in: query
        description: The ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: password
        in: query
        description: The host management interface password
        required: true
        schema:
          type: string
          maxLength: 255
      - name: port
        in: query
        description: The host management interface port
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: The host management interface user
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `configureOutOfBandManagement`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configureoutofbandmanagementresponse:
                    oneOf:
                    - &id042
                      $ref: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id042
                        - type: array
                          items: *id042
                required:
                - configureoutofbandmanagementresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configureoutofbandmanagementresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configureoutofbandmanagementresponse
      x-cloudstack-command: configureOutOfBandManagement
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - changeOutOfBandManagementPassword
      - enableOutOfBandManagementForHost
  /configureOvsElement:
    get:
      operationId: configureOvsElement
      summary: Configures an ovs element.
      description: |-
        Configures an ovs element.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - OvsElement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configureOvsElement
          default: configureOvsElement
      - $ref: '#/components/parameters/response'
      - name: enabled
        in: query
        description: Enabled/Disabled the service provider
        required: true
        schema:
          type: boolean
      - name: id
        in: query
        description: The ID of the ovs provider
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - configureOvsElement
      responses:
        '200':
          description: Successful invocation of `configureOvsElement`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configureovselementresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - configureovselementresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configureovselementresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configureovselementresponse
      x-cloudstack-command: configureOvsElement
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualRouterElement'
  /configurePaloAltoFirewall:
    get:
      operationId: configurePaloAltoFirewall
      summary: Configures a Palo Alto firewall device
      description: |-
        Configures a Palo Alto firewall device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PaloAltoFirewall
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configurePaloAltoFirewall
          default: configurePaloAltoFirewall
      - $ref: '#/components/parameters/response'
      - name: fwdeviceid
        in: query
        description: Palo Alto firewall device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - configurePaloAltoFirewall
        - listPaloAltoFirewalls
      - name: fwdevicecapacity
        in: query
        description: Capacity of the firewall device, Capacity will be interpreted as number of networks device can handle
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `configurePaloAltoFirewall`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurepaloaltofirewallresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - configurepaloaltofirewallresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurepaloaltofirewallresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configurepaloaltofirewallresponse
      x-cloudstack-command: configurePaloAltoFirewall
      x-cloudstack-async: true
      x-cloudstack-related:
      - listPaloAltoFirewalls
      x-cloudstack-jobresult-schema: '#/components/schemas/PaloAltoFirewall'
  /configureStorageAccess:
    get:
      operationId: configureStorageAccess
      summary: Configure the storage access groups on zone/pod/cluster/host and storage, accordingly connections to the storage pools
      description: |-
        Configure the storage access groups on zone/pod/cluster/host and storage, accordingly connections to the storage pools

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StorageAccess
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configureStorageAccess
          default: configureStorageAccess
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: UUID of the cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: hostid
        in: query
        description: UUID of the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      - name: podid
        in: query
        description: UUID of the pod
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: storageaccessgroups
        in: query
        description: comma separated list of storage access groups for connecting the storage pools and the hosts. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
      - name: storageid
        in: query
        description: UUID of the Storage Pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: zoneid
        in: query
        description: UUID of the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `configureStorageAccess`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurestorageaccessresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - configurestorageaccessresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurestorageaccessresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configurestorageaccessresponse
      x-cloudstack-command: configureStorageAccess
      x-cloudstack-async: true
      x-cloudstack-since: 4.21.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /configureVirtualRouterElement:
    get:
      operationId: configureVirtualRouterElement
      summary: Configures a virtual router element.
      description: |-
        Configures a virtual router element.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualRouterElement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: configureVirtualRouterElement
          default: configureVirtualRouterElement
      - $ref: '#/components/parameters/response'
      - name: enabled
        in: query
        description: Enabled/Disabled the service provider
        required: true
        schema:
          type: boolean
      - name: id
        in: query
        description: The ID of the virtual router provider
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - configureVirtualRouterElement
      responses:
        '200':
          description: Successful invocation of `configureVirtualRouterElement`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurevirtualrouterelementresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - configurevirtualrouterelementresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurevirtualrouterelementresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - configurevirtualrouterelementresponse
      x-cloudstack-command: configureVirtualRouterElement
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualRouterElement'
  /copyIso:
    get:
      operationId: copyIso
      summary: Copies an ISO from one zone to another.
      description: |-
        Copies an ISO from one zone to another.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Iso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: copyIso
          default: copyIso
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Template ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: destzoneid
        in: query
        description: ID of the zone the Template is being copied to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: destzoneids
        in: query
        description: A list of IDs of the zones that the Template needs to be copied to.Specify this list if the Template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: sourcezoneid
        in: query
        description: ID of the zone the Template is currently hosted on. If not specified and Template is cross-zone, then we will sync this Template to region wide image store.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `copyIso`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  copyisoresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - copyisoresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  copyisoresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - copyisoresponse
      x-cloudstack-command: copyIso
      x-cloudstack-async: true
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - prepareTemplate
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateIso
      - updateTemplate
      - updateVnfTemplate
      x-cloudstack-jobresult-schema: '#/components/schemas/Template'
  /copySnapshot:
    get:
      operationId: copySnapshot
      summary: Copies a snapshot from one zone to another.
      description: |-
        Copies a snapshot from one zone to another.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Snapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: copySnapshot
          default: copySnapshot
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the snapshot.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copySnapshot
        - listSnapshots
      - name: destzoneid
        in: query
        description: The ID of the zone the snapshot is being copied to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: destzoneids
        in: query
        description: A comma-separated list of IDs of the zones that the snapshot needs to be copied to. Specify this list if the snapshot needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listZones
      - name: sourcezoneid
        in: query
        description: The ID of the zone in which the snapshot is currently present. If not specified then the zone of snapshot's volume will be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: storageids
        in: query
        description: A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. Currently supported for StorPool only. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
      - name: usestoragereplication
        in: query
        description: Enables the snapshot to be copied to the supported primary storages when the config 'use.storage.replication' is set to true for the storage or globally. This is supported only for StorPool storage for now.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      responses:
        '200':
          description: Successful invocation of `copySnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  copysnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - copysnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  copysnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - copysnapshotresponse
      x-cloudstack-command: copySnapshot
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - listSnapshots
      x-cloudstack-jobresult-schema: '#/components/schemas/Snapshot'
  /copyTemplate:
    get:
      operationId: copyTemplate
      summary: Copies a Template from one zone to another.
      description: |-
        Copies a Template from one zone to another.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: copyTemplate
          default: copyTemplate
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Template ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: destzoneid
        in: query
        description: ID of the zone the Template is being copied to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: destzoneids
        in: query
        description: A list of IDs of the zones that the Template needs to be copied to.Specify this list if the Template needs to copied to multiple zones in one go. Do not specify destzoneid and destzoneids together, however one of them is required. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: sourcezoneid
        in: query
        description: ID of the zone the Template is currently hosted on. If not specified and Template is cross-zone, then we will sync this Template to region wide image store.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `copyTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  copytemplateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - copytemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  copytemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - copytemplateresponse
      x-cloudstack-command: copyTemplate
      x-cloudstack-async: true
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - prepareTemplate
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateIso
      - updateTemplate
      - updateVnfTemplate
      x-cloudstack-jobresult-schema: '#/components/schemas/Template'
  /createASNRange:
    get:
      operationId: createASNRange
      summary: Creates a range of Autonomous Systems for BGP Dynamic Routing
      tags:
      - ASNRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createASNRange
          default: createASNRange
      - $ref: '#/components/parameters/response'
      - name: endasn
        in: query
        description: the end AS Number
        required: true
        schema:
          type: integer
          format: int64
      - name: startasn
        in: query
        description: the start AS Number
        required: true
        schema:
          type: integer
          format: int64
      - name: zoneid
        in: query
        description: the zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `createASNRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createasnrangeresponse:
                    oneOf:
                    - &id043
                      $ref: '#/components/schemas/ASNRange'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id043
                        - type: array
                          items: *id043
                required:
                - createasnrangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createasnrangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createasnrangeresponse
      x-cloudstack-command: createASNRange
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - listASNRanges
  /createAccount:
    get:
      operationId: createAccount
      summary: Creates an account
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createAccount
          default: createAccount
      - $ref: '#/components/parameters/response'
      - name: email
        in: query
        description: E-mail
        required: true
        schema:
          type: string
          maxLength: 255
      - name: firstname
        in: query
        description: First name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: lastname
        in: query
        description: Last name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Unique username.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: Name of the Account to be created. The user will be added to this newly created account. If no Account is specified, the username will be used as the Account name.
        schema:
          type: string
          maxLength: 255
      - name: accountdetails
        in: query
        description: Details for Account used to store specific parameters. Map parameter. CloudStack expects it index-encoded as `accountdetails[0].key=k&accountdetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: accountid
        in: query
        description: Account UUID, required for adding Account from external provisioning system
        schema:
          type: string
          maxLength: 255
      - name: accounttype
        in: query
        description: Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin
        schema:
          type: integer
          format: int32
      - name: domainid
        in: query
        description: Creates the user under the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: networkdomain
        in: query
        description: Network domain for the Account's Networks
        schema:
          type: string
          maxLength: 255
      - name: roleid
        in: query
        description: Creates the account under the specified role.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - importRole
        - listRoles
        - updateRole
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
        schema:
          type: string
          maxLength: 255
      - name: userid
        in: query
        description: User UUID, required for adding Account from external provisioning system
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createAccount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createaccountresponse:
                    oneOf:
                    - &id044
                      $ref: '#/components/schemas/Account'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id044
                        - type: array
                          items: *id044
                required:
                - createaccountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createaccountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createaccountresponse
      x-cloudstack-command: createAccount
      x-cloudstack-async: false
      x-cloudstack-related:
      - disableAccount
      - enableAccount
      - listAccounts
      - lockAccount
      - markDefaultZoneForAccount
      - updateAccount
  /createAffinityGroup:
    get:
      operationId: createAffinityGroup
      summary: Creates an affinity/anti-affinity group
      description: |-
        Creates an affinity/anti-affinity group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AffinityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createAffinityGroup
          default: createAffinityGroup
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the affinity group
        required: true
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: Type of the affinity group from the available affinity/anti-affinity group types
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: An account for the affinity group. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: Optional description of the affinity group
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: DomainId of the account owning the affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: projectid
        in: query
        description: Create affinity group for project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `createAffinityGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createaffinitygroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createaffinitygroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createaffinitygroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createaffinitygroupresponse
      x-cloudstack-command: createAffinityGroup
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/AffinityGroup'
  /createAutoScalePolicy:
    get:
      operationId: createAutoScalePolicy
      summary: Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration.
      description: |-
        Creates an autoscale policy for a provision or deprovision action, the action is taken when the all the conditions evaluates to true for the specified duration. The policy is in effect once it is attached to a autscale Instance group.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScalePolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createAutoScalePolicy
          default: createAutoScalePolicy
      - $ref: '#/components/parameters/response'
      - name: action
        in: query
        description: The action to be executed if all the conditions evaluate to true for the specified duration.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: conditionids
        in: query
        description: The list of IDs of the conditions that are being evaluated on every interval. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createCondition
        - listConditions
      - name: duration
        in: query
        description: The duration in which the conditions have to be true before action is taken
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: The name of the autoscale policy
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: quiettime
        in: query
        description: The cool down period in which the policy should not be evaluated after the action has been taken
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `createAutoScalePolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createautoscalepolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createautoscalepolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createautoscalepolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createautoscalepolicyresponse
      x-cloudstack-command: createAutoScalePolicy
      x-cloudstack-async: true
      x-cloudstack-related:
      - listAutoScalePolicies
      - updateAutoScalePolicy
      x-cloudstack-jobresult-schema: '#/components/schemas/AutoScalePolicy'
  /createAutoScaleVmGroup:
    get:
      operationId: createAutoScaleVmGroup
      summary: Creates and automatically starts an Instance based on a service offering, disk offering, and Template.
      description: |-
        Creates and automatically starts an Instance based on a service offering, disk offering, and Template.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScaleVmGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createAutoScaleVmGroup
          default: createAutoScaleVmGroup
      - $ref: '#/components/parameters/response'
      - name: lbruleid
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: maxmembers
        in: query
        description: The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.
        required: true
        schema:
          type: integer
          format: int32
      - name: minmembers
        in: query
        description: The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.
        required: true
        schema:
          type: integer
          format: int32
      - name: scaledownpolicyids
        in: query
        description: List of scaledown autoscale policies. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listAutoScalePolicies
        - updateAutoScalePolicy
      - name: scaleuppolicyids
        in: query
        description: List of scaleup autoscale policies. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listAutoScalePolicies
        - updateAutoScalePolicy
      - name: vmprofileid
        in: query
        description: The autoscale profile that contains information about the Instances in the Instance group.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAutoScaleVmProfile
        - listAutoScaleVmProfiles
        - updateAutoScaleVmProfile
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the group to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: interval
        in: query
        description: The frequency in which the performance counters to be collected
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: The name of the autoscale Instance Group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      responses:
        '200':
          description: Successful invocation of `createAutoScaleVmGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createautoscalevmgroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createautoscalevmgroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createautoscalevmgroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createautoscalevmgroupresponse
      x-cloudstack-command: createAutoScaleVmGroup
      x-cloudstack-async: true
      x-cloudstack-related:
      - disableAutoScaleVmGroup
      - enableAutoScaleVmGroup
      - listAutoScaleVmGroups
      - updateAutoScaleVmGroup
      x-cloudstack-jobresult-schema: '#/components/schemas/AutoScaleVmGroup'
  /createAutoScaleVmProfile:
    get:
      operationId: createAutoScaleVmProfile
      summary: Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature.
      description: |-
        Creates a profile that contains information about the Instance which will be provisioned automatically by autoscale feature.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScaleVmProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createAutoScaleVmProfile
          default: createAutoScaleVmProfile
      - $ref: '#/components/parameters/response'
      - name: serviceofferingid
        in: query
        description: The service offering of the auto deployed Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: templateid
        in: query
        description: The Template of the auto deployed Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: zoneid
        in: query
        description: Availability zone for the auto deployed Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: Account that will own the autoscale Instance profile
        schema:
          type: string
          maxLength: 255
      - name: autoscaleuserid
        in: query
        description: The ID of the user used to launch and destroy the Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
        - lockUser
      - name: counterparam
        in: query
        description: 'counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161. Map parameter. CloudStack expects it index-encoded as `counterparam[0].key=k&counterparam[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: domainid
        in: query
        description: Domain ID of the Account owning an autoscale Instance profile
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: expungevmgraceperiod
        in: query
        description: The time allowed for existing connections to get closed before an Instance is expunged
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the profile to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: otherdeployparams
        in: query
        description: |-
          Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed  Instance.
          Example: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .
          Possible parameters are "rootdisksize", "diskofferingid","size", "securitygroupids", "overridediskofferingid", "keypairs", "affinitygroupids'" and "networkids". Map parameter. CloudStack expects it index-encoded as `otherdeployparams[0].key=k&otherdeployparams[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: projectid
        in: query
        description: An optional project for the autoscale Instance profile
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: userdata
        in: query
        description: An optional binary data that can be sent to the Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value
        schema:
          type: string
          maxLength: 1048576
        x-cloudstack-since: 4.18.0
      - name: userdatadetails
        in: query
        description: used to specify the parameters values for the variables in userdata. Map parameter. CloudStack expects it index-encoded as `userdatadetails[0].key=k&userdatadetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.18.1
      - name: userdataid
        in: query
        description: the ID of the Userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.18.1
        x-cloudstack-related:
        - listCniConfiguration
      responses:
        '200':
          description: Successful invocation of `createAutoScaleVmProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createautoscalevmprofileresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createautoscalevmprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createautoscalevmprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createautoscalevmprofileresponse
      x-cloudstack-command: createAutoScaleVmProfile
      x-cloudstack-async: true
      x-cloudstack-related:
      - listAutoScaleVmProfiles
      - updateAutoScaleVmProfile
      x-cloudstack-jobresult-schema: '#/components/schemas/AutoScaleVmProfile'
  /createBackup:
    get:
      operationId: createBackup
      summary: Create Instance backup
      description: |-
        Create Instance backup

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Backup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createBackup
          default: createBackup
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
        - updateVmNicIp
      - name: description
        in: query
        description: the description for the backup
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: isolated
        in: query
        description: Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: name
        in: query
        description: the name of the backup
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: quiescevm
        in: query
        description: Quiesce the instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      responses:
        '200':
          description: Successful invocation of `createBackup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbackupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createbackupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbackupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createbackupresponse
      x-cloudstack-command: createBackup
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /createBackupOffering:
    get:
      operationId: createBackupOffering
      summary: Creates a backup offering
      tags:
      - BackupOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createBackupOffering
          default: createBackupOffering
      - $ref: '#/components/parameters/response'
      - name: allowuserdrivenbackups
        in: query
        description: Whether users are allowed to create ad-hoc backups and backup schedules when using this offering.
        required: true
        schema:
          type: boolean
      - name: description
        in: query
        description: The description of the backup offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Backup offering name.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: Restrict the backup offering to the Zone identified by this ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: allowextractfile
        in: query
        description: Whether files may be extracted from backups or not.
        schema:
          type: boolean
      - name: allowquickrestore
        in: query
        description: Whether quick restore is enabled for the backups or not.
        schema:
          type: boolean
      - name: backupchainsize
        in: query
        description: Backup chain size for backups created with this offering.
        schema:
          type: integer
          format: int32
      - name: compress
        in: query
        description: Whether the backups should be compressed or not.
        schema:
          type: boolean
      - name: compressionlibrary
        in: query
        description: Compression library, for offerings that support compression. Accepted values are zstd and zlib. By default, zstd is used for images that support it. If the image only supports zlib, it will be used regardless of this parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Restrict the backup offering to the Domains identified by these IDs. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listDomains
      - name: validate
        in: query
        description: Whether the backups should be validated or not.
        schema:
          type: boolean
      - name: validationsteps
        in: query
        description: 'Which validation steps should be performed. Accepts a comma-separated list of steps. Accepted values are: wait_for_boot, screenshot and execute_command.'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createBackupOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbackupofferingresponse:
                    oneOf:
                    - &id045
                      $ref: '#/components/schemas/BackupOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id045
                        - type: array
                          items: *id045
                required:
                - createbackupofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbackupofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createbackupofferingresponse
      x-cloudstack-command: createBackupOffering
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /createBackupSchedule:
    get:
      operationId: createBackupSchedule
      summary: Creates a User-defined Instance backup schedule
      tags:
      - BackupSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createBackupSchedule
          default: createBackupSchedule
      - $ref: '#/components/parameters/response'
      - name: intervaltype
        in: query
        description: Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY
        required: true
        schema:
          type: string
          maxLength: 255
      - name: schedule
        in: query
        description: Custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: ID of the Instance for which schedule is to be defined
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
        - updateVmNicIp
      - name: isolated
        in: query
        description: Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: maxbackups
        in: query
        description: The maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.21.0
      - name: quiescevm
        in: query
        description: Quiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      responses:
        '200':
          description: Successful invocation of `createBackupSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbackupscheduleresponse:
                    oneOf:
                    - &id046
                      $ref: '#/components/schemas/BackupSchedule'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id046
                        - type: array
                          items: *id046
                required:
                - createbackupscheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbackupscheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createbackupscheduleresponse
      x-cloudstack-command: createBackupSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
      x-cloudstack-related:
      - listBackupSchedule
  /createBgpPeer:
    get:
      operationId: createBgpPeer
      summary: Creates a Bgp Peer for a zone.
      description: |-
        Creates a Bgp Peer for a zone.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BgpPeer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createBgpPeer
          default: createBgpPeer
      - $ref: '#/components/parameters/response'
      - name: asnumber
        in: query
        description: The AS number of the Bgp Peer.
        required: true
        schema:
          type: integer
          format: int64
      - name: zoneid
        in: query
        description: UUID of the zone which the Bgp Peer belongs to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: account who will own the Bgp Peer
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: BGP peer details in key/value pairs. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: domainid
        in: query
        description: domain ID of the account owning the Bgp Peer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: ip6address
        in: query
        description: The IPv6 address of the Bgp Peer.
        schema:
          type: string
          maxLength: 255
      - name: ipaddress
        in: query
        description: The IPv4 address of the Bgp Peer.
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: The password of the Bgp Peer.
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: project who will own the Bgp Peer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `createBgpPeer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbgppeerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createbgppeerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbgppeerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createbgppeerresponse
      x-cloudstack-command: createBgpPeer
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - dedicateBgpPeer
      - listBgpPeers
      - releaseBgpPeer
      x-cloudstack-jobresult-schema: '#/components/schemas/BgpPeer'
  /createBucket:
    get:
      operationId: createBucket
      summary: Creates a bucket in the specified object storage pool.
      description: |-
        Creates a bucket in the specified object storage pool.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Bucket
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createBucket
          default: createBucket
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: the name of the bucket
        required: true
        schema:
          type: string
          maxLength: 255
      - name: objectstorageid
        in: query
        description: Id of the Object Storage Pool where bucket is created
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addObjectStoragePool
      - name: quota
        in: query
        description: Bucket Quota in GiB
        required: true
        schema:
          type: integer
          format: int32
      - name: account
        in: query
        description: the account associated with the bucket. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: the domain ID associated with the bucket. If used with the account parameter returns the bucket associated with the account for the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: encryption
        in: query
        description: Enable bucket encryption
        schema:
          type: boolean
      - name: objectlocking
        in: query
        description: Enable object locking in bucket
        schema:
          type: boolean
      - name: policy
        in: query
        description: The Bucket access policy
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: the project associated with the bucket. Mutually exclusive with account parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: versioning
        in: query
        description: Enable bucket versioning
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `createBucket`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbucketresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createbucketresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createbucketresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createbucketresponse
      x-cloudstack-command: createBucket
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - listBuckets
      x-cloudstack-jobresult-schema: '#/components/schemas/Bucket'
  /createCondition:
    get:
      operationId: createCondition
      summary: Creates a condition for Instance auto scaling
      description: |-
        Creates a condition for Instance auto scaling

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Condition
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createCondition
          default: createCondition
      - $ref: '#/components/parameters/response'
      - name: counterid
        in: query
        description: ID of the Counter.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createCounter
        - listCounters
      - name: relationaloperator
        in: query
        description: Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: threshold
        in: query
        description: Value for which the Counter will be evaluated with the Operator selected.
        required: true
        schema:
          type: integer
          format: int64
      - name: account
        in: query
        description: The account of the condition. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID of the account.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: projectid
        in: query
        description: An optional project for condition
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `createCondition`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createconditionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createconditionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createconditionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createconditionresponse
      x-cloudstack-command: createCondition
      x-cloudstack-async: true
      x-cloudstack-related:
      - listConditions
      x-cloudstack-jobresult-schema: '#/components/schemas/Condition'
  /createConsoleEndpoint:
    get:
      operationId: createConsoleEndpoint
      summary: Create a console endpoint to connect to a Instance console
      tags:
      - ConsoleEndpoint
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createConsoleEndpoint
          default: createConsoleEndpoint
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: token
        in: query
        description: (optional) extra security token, valid when the extra validation is enabled
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createConsoleEndpoint`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createconsoleendpointresponse:
                    oneOf:
                    - &id047
                      $ref: '#/components/schemas/ConsoleEndpoint'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id047
                        - type: array
                          items: *id047
                required:
                - createconsoleendpointresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createconsoleendpointresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createconsoleendpointresponse
      x-cloudstack-command: createConsoleEndpoint
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
  /createCounter:
    get:
      operationId: createCounter
      summary: Adds metric counter for Instance auto scaling
      description: |-
        Adds metric counter for Instance auto scaling

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Counter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createCounter
          default: createCounter
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the counter.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: Network provider of the counter.
        required: true
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: source
        in: query
        description: Source of the counter.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: value
        in: query
        description: Value of the counter e.g. oid in case of snmp.
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createCounter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createcounterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createcounterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createcounterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createcounterresponse
      x-cloudstack-command: createCounter
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/Counter'
  /createDiskOffering:
    get:
      operationId: createDiskOffering
      summary: Creates a disk offering.
      tags:
      - DiskOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createDiskOffering
          default: createDiskOffering
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the disk offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: bytesreadrate
        in: query
        description: Bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: bytesreadratemax
        in: query
        description: Burst bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: bytesreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: byteswriterate
        in: query
        description: Bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: byteswriteratemax
        in: query
        description: Burst bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: byteswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: cachemode
        in: query
        description: The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.14'
      - name: customized
        in: query
        description: Whether disk offering size is custom or not
        schema:
          type: boolean
      - name: customizediops
        in: query
        description: Whether disk offering IOPS is custom or not
        schema:
          type: boolean
      - name: details
        in: query
        description: Details to specify disk offering parameters. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.16'
      - name: disksize
        in: query
        description: Size of the disk offering in GB (1GB = 1,073,741,824 bytes)
        schema:
          type: integer
          format: int64
      - name: disksizestrictness
        in: query
        description: To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed
        schema:
          type: boolean
        x-cloudstack-since: '4.17'
      - name: displayoffering
        in: query
        description: An optional field, whether to display the offering to the end user or not.
        schema:
          type: boolean
      - name: displaytext
        in: query
        description: An alternate display text of the disk offering, defaults to 'name'.
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: The ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: encrypt
        in: query
        description: Volumes using this offering should be encrypted
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: hypervisorsnapshotreserve
        in: query
        description: Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
        schema:
          type: integer
          format: int32
      - name: iopsreadrate
        in: query
        description: I/O requests read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopsreadratemax
        in: query
        description: Burst requests read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopsreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: iopswriterate
        in: query
        description: I/O requests write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopswriteratemax
        in: query
        description: Burst I/O requests write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: maxiops
        in: query
        description: Max IOPS of the disk offering
        schema:
          type: integer
          format: int64
      - name: miniops
        in: query
        description: Min IOPS of the disk offering
        schema:
          type: integer
          format: int64
      - name: provisioningtype
        in: query
        description: Provisioning type used to create volumes. Valid values are thin, sparse, fat.
        schema:
          type: string
          maxLength: 255
      - name: storagepolicy
        in: query
        description: Name of the storage policy defined at vCenter, this is applicable only for VMware
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.15'
        x-cloudstack-related:
        - listVsphereStoragePolicies
      - name: storagetype
        in: query
        description: The storage type of the disk offering. Values are local and shared.
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: Tags for the disk offering
        schema:
          type: string
          maxLength: 4096
      - name: zoneid
        in: query
        description: The ID of the containing zone(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `createDiskOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creatediskofferingresponse:
                    oneOf:
                    - &id048
                      $ref: '#/components/schemas/DiskOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id048
                        - type: array
                          items: *id048
                required:
                - creatediskofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creatediskofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - creatediskofferingresponse
      x-cloudstack-command: createDiskOffering
      x-cloudstack-async: false
  /createDnsRecord:
    get:
      operationId: createDnsRecord
      summary: Creates a DNS record directly on the provider
      description: |-
        Creates a DNS record directly on the provider

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DnsRecord
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createDnsRecord
          default: createDnsRecord
      - $ref: '#/components/parameters/response'
      - name: contents
        in: query
        description: The content of the record (IP address for A/AAAA, FQDN for CNAME/NS, quoted string for TXT, etc.). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: dnszoneid
        in: query
        description: ID of the DNS zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: name
        in: query
        description: DNS record name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: DNS record type (e.g., A, AAAA, CNAME, MX, TXT, etc.)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ttl
        in: query
        description: Time to live
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `createDnsRecord`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creatednsrecordresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - creatednsrecordresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creatednsrecordresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - creatednsrecordresponse
      x-cloudstack-command: createDnsRecord
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-jobresult-schema: '#/components/schemas/DnsRecord'
  /createDnsZone:
    get:
      operationId: createDnsZone
      summary: Creates a new DNS Zone on a specific server
      description: |-
        Creates a new DNS Zone on a specific server

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DnsZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createDnsZone
          default: createDnsZone
      - $ref: '#/components/parameters/response'
      - name: dnsserverid
        in: query
        description: The ID of the DNS server to host this zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addDnsServer
        - listDnsServers
        - updateDnsServer
      - name: name
        in: query
        description: The name of the DNS zone (e.g. example.com)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: The description of the DNS zone
        schema:
          type: string
          maxLength: 255
      - name: existing
        in: query
        description: If true, imports an existing DNS zone from the DNS provider into CloudStack. If false, creates the zone in the DNS provider and registers it in CloudStack. Default is false
        schema:
          type: boolean
        x-cloudstack-related:
        - createDnsZone
        - listDnsZones
      - name: type
        in: query
        description: The type of zone (Public, Private). Defaults to Public.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createDnsZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creatednszoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - creatednszoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creatednszoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - creatednszoneresponse
      x-cloudstack-command: createDnsZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - listDnsZones
      x-cloudstack-jobresult-schema: '#/components/schemas/DnsZone'
  /createDomain:
    get:
      operationId: createDomain
      summary: Creates a domain
      tags:
      - Domain
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createDomain
          default: createDomain
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Creates domain with this name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Domain UUID, required for adding domain from another Region
        schema:
          type: string
          maxLength: 255
      - name: networkdomain
        in: query
        description: Network domain for networks in the domain
        schema:
          type: string
          maxLength: 255
      - name: parentdomainid
        in: query
        description: Assigns new domain a parent domain by domain ID of the parent. If no parent domain is specified, the ROOT domain is assumed.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      responses:
        '200':
          description: Successful invocation of `createDomain`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createdomainresponse:
                    oneOf:
                    - &id049
                      $ref: '#/components/schemas/Domain'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id049
                        - type: array
                          items: *id049
                required:
                - createdomainresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createdomainresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createdomainresponse
      x-cloudstack-command: createDomain
      x-cloudstack-async: false
      x-cloudstack-related:
      - listDomains
  /createEgressFirewallRule:
    get:
      operationId: createEgressFirewallRule
      summary: Creates a egress firewall rule for a given network
      description: |-
        Creates a egress firewall rule for a given network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - EgressFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createEgressFirewallRule
          default: createEgressFirewallRule
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: The Network ID of the port forwarding rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: protocol
        in: query
        description: The protocol for the firewall rule. Valid values are TCP/UDP/ICMP.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: destcidrlist
        in: query
        description: The CIDR list to forward traffic to. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: endport
        in: query
        description: The ending port of firewall rule
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: icmpcode
        in: query
        description: Error code for this ICMP message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: Type of the ICMP message being sent
        schema:
          type: integer
          format: int32
      - name: startport
        in: query
        description: The starting port of firewall rule
        schema:
          type: integer
          format: int32
      - name: type
        in: query
        description: 'Type of firewallrule: system/user'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createEgressFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createegressfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createegressfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createegressfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createegressfirewallruleresponse
      x-cloudstack-command: createEgressFirewallRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - createFirewallRule
      - listEgressFirewallRules
      - listFirewallRules
      - updateEgressFirewallRule
      - updateFirewallRule
      x-cloudstack-jobresult-schema: '#/components/schemas/EgressFirewallRule'
  /createExtension:
    get:
      operationId: createExtension
      summary: Create an extension
      tags:
      - Extension
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createExtension
          default: createExtension
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the extension
        required: true
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: Type of the extension
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: Description of the extension
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: orchestratorrequirespreparevm
        in: query
        description: Only honored when type is Orchestrator. Whether prepare VM is needed or not
        schema:
          type: boolean
      - name: path
        in: query
        description: Relative path for the extension
        schema:
          type: string
          maxLength: 255
      - name: reservedresourcedetails
        in: query
        description: Resource detail names as comma separated string that should be reserved and not visible to end users
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.22.1
      - name: state
        in: query
        description: State of the extension
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createExtension`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createextensionresponse:
                    oneOf:
                    - &id050
                      $ref: '#/components/schemas/Extension'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id050
                        - type: array
                          items: *id050
                required:
                - createextensionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createextensionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createextensionresponse
      x-cloudstack-command: createExtension
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - deleteExtension
      - listExtensions
      - registerExtension
      - unregisterExtension
      - updateExtension
  /createFirewallRule:
    get:
      operationId: createFirewallRule
      summary: Creates a firewall rule for a given IP address
      description: |-
        Creates a firewall rule for a given IP address

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - FirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createFirewallRule
          default: createFirewallRule
      - $ref: '#/components/parameters/response'
      - name: ipaddressid
        in: query
        description: The IP address ID of the port forwarding rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
      - name: protocol
        in: query
        description: The protocol for the firewall rule. Valid values are TCP/UDP/ICMP.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: endport
        in: query
        description: The ending port of firewall rule
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: icmpcode
        in: query
        description: Error code for this icmp message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: Type of the ICMP message being sent
        schema:
          type: integer
          format: int32
      - name: startport
        in: query
        description: The starting port of firewall rule
        schema:
          type: integer
          format: int32
      - name: type
        in: query
        description: 'Type of firewallrule: system/user'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createfirewallruleresponse
      x-cloudstack-command: createFirewallRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - updateEgressFirewallRule
      x-cloudstack-jobresult-schema: '#/components/schemas/EgressFirewallRule'
  /createGlobalLoadBalancerRule:
    get:
      operationId: createGlobalLoadBalancerRule
      summary: Creates a global load balancer rule
      description: |-
        Creates a global load balancer rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GlobalLoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createGlobalLoadBalancerRule
          default: createGlobalLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: gslbdomainname
        in: query
        description: Domain name for the GSLB service.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: gslbservicetype
        in: query
        description: GSLB service type (tcp, udp, http)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the load balancer rule
        required: true
        schema:
          type: string
          maxLength: 255
      - name: regionid
        in: query
        description: Region where the global load balancer is going to be created.
        required: true
        schema:
          type: integer
          format: int32
        x-cloudstack-related:
        - addRegion
        - listRegions
        - updateRegion
      - name: account
        in: query
        description: The Account associated with the global load balancer. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: The description of the load balancer rule
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: The domain ID associated with the load balancer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: gslblbmethod
        in: query
        description: Load balancer algorithm (roundrobin, leastconn, proximity) that method is used to distribute traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'
        schema:
          type: string
          maxLength: 255
      - name: gslbstickysessionmethodname
        in: query
        description: Session sticky method (sourceip) if not specified defaults to sourceip
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createGlobalLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creategloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - creategloballoadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creategloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - creategloballoadbalancerruleresponse
      x-cloudstack-command: createGlobalLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - listGlobalLoadBalancerRules
      - updateGlobalLoadBalancerRule
      x-cloudstack-jobresult-schema: '#/components/schemas/GlobalLoadBalancerRule'
  /createGpuCard:
    get:
      operationId: createGpuCard
      summary: Creates a GPU card definition in the system
      tags:
      - GpuCard
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createGpuCard
          default: createGpuCard
      - $ref: '#/components/parameters/response'
      - name: deviceid
        in: query
        description: the device ID of the GPU card
        required: true
        schema:
          type: string
          maxLength: 255
      - name: devicename
        in: query
        description: the device name of the GPU card
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: the display name of the GPU card
        required: true
        schema:
          type: string
          maxLength: 255
      - name: vendorid
        in: query
        description: the vendor ID of the GPU card
        required: true
        schema:
          type: string
          maxLength: 255
      - name: vendorname
        in: query
        description: the vendor name of the GPU card
        required: true
        schema:
          type: string
          maxLength: 255
      - name: videoram
        in: query
        description: the video RAM size in MB for the passthrough vGPU profile
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `createGpuCard`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creategpucardresponse:
                    oneOf:
                    - &id051
                      $ref: '#/components/schemas/GpuCard'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id051
                        - type: array
                          items: *id051
                required:
                - creategpucardresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creategpucardresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - creategpucardresponse
      x-cloudstack-command: createGpuCard
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - listGpuCards
      - updateGpuCard
  /createGpuDevice:
    get:
      operationId: createGpuDevice
      summary: Creates a GPU device manually on a host
      tags:
      - GpuDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createGpuDevice
          default: createGpuDevice
      - $ref: '#/components/parameters/response'
      - name: busaddress
        in: query
        description: PCI bus address of the GPU device (e.g., 0000:01:00.0) or UUID for MDEV devices.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: gpucardid
        in: query
        description: ID of the GPU card type
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: hostid
        in: query
        description: ID of the host where the GPU device is located
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: vgpuprofileid
        in: query
        description: ID of the vGPU profile
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: numanode
        in: query
        description: NUMA node of the GPU device (e.g., 0, 1, etc.). This is optional and can be used to specify the NUMA node for the GPU device which is used during allocation. Defaults to -1
        schema:
          type: string
          maxLength: 255
      - name: parentgpudeviceid
        in: query
        description: ID of the parent GPU device (for virtual GPU devices)
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createGpuDevice
        - discoverGpuDevices
        - listGpuDevices
      - name: type
        in: query
        description: Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createGpuDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creategpudeviceresponse:
                    oneOf:
                    - &id052
                      $ref: '#/components/schemas/GpuDevice'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id052
                        - type: array
                          items: *id052
                required:
                - creategpudeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  creategpudeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - creategpudeviceresponse
      x-cloudstack-command: createGpuDevice
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - discoverGpuDevices
      - listGpuDevices
  /createGuestNetworkIpv6Prefix:
    get:
      operationId: createGuestNetworkIpv6Prefix
      summary: Creates a guest network IPv6 prefix.
      description: |-
        Creates a guest network IPv6 prefix.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GuestNetworkIpv6Prefix
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createGuestNetworkIpv6Prefix
          default: createGuestNetworkIpv6Prefix
      - $ref: '#/components/parameters/response'
      - name: prefix
        in: query
        description: The /56 or higher IPv6 CIDR for network prefix.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: UUID of zone to which the IPv6 prefix belongs to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createGuestNetworkIpv6Prefix`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createguestnetworkipv6prefixresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createguestnetworkipv6prefixresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createguestnetworkipv6prefixresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createguestnetworkipv6prefixresponse
      x-cloudstack-command: createGuestNetworkIpv6Prefix
      x-cloudstack-async: true
      x-cloudstack-since: 4.17.0.0
      x-cloudstack-related:
      - listGuestNetworkIpv6Prefixes
      x-cloudstack-jobresult-schema: '#/components/schemas/CreateGuestNetworkIpv6PrefixResult'
  /createGuiTheme:
    get:
      operationId: createGuiTheme
      summary: Creates a customized GUI theme for a set of Common Names (fixed or wildcard), a set of domain UUIDs, and/or a set of account UUIDs.
      tags:
      - GuiTheme
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createGuiTheme
          default: createGuiTheme
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: A name to identify the theme.
        required: true
        schema:
          type: string
          maxLength: 2048
      - name: accountids
        in: query
        description: A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
        schema:
          type: string
          maxLength: 65535
      - name: commonnames
        in: query
        description: 'A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com'
        schema:
          type: string
          maxLength: 65535
      - name: css
        in: query
        description: The CSS to be retrieved and imported into the GUI when matching the theme access configurations.
        schema:
          type: string
          maxLength: 65535
      - name: description
        in: query
        description: A description for the theme.
        schema:
          type: string
          maxLength: 4096
      - name: domainids
        in: query
        description: A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
        schema:
          type: string
          maxLength: 65535
      - name: ispublic
        in: query
        description: Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.
        schema:
          type: boolean
      - name: jsonconfiguration
        in: query
        description: The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.
        schema:
          type: string
          maxLength: 65535
      - name: loginbasedomain
        in: query
        description: The ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.
        schema:
          type: string
          maxLength: 65535
      - name: recursivedomains
        in: query
        description: Defines whether the subdomains of the informed domains are considered. Default value is false.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `createGuiTheme`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createguithemeresponse:
                    oneOf:
                    - &id053
                      $ref: '#/components/schemas/GuiTheme'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id053
                        - type: array
                          items: *id053
                required:
                - createguithemeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createguithemeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createguithemeresponse
      x-cloudstack-command: createGuiTheme
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0.0
  /createHSMProfile:
    get:
      operationId: createHSMProfile
      summary: Creates a new HSM profile
      tags:
      - HSMProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createHSMProfile
          default: createHSMProfile
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: the name of the HSM profile
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: the account name of the HSM profile owner. Must be used with domainId. Leave empty (with a domainId) to create a domain-scoped profile shared by all accounts in that domain.
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: HSM configuration details (protocol specific). Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: domainid
        in: query
        description: the domain ID where the HSM profile is available. If specified without an account, the profile is domain-scoped and usable by all accounts directly in that domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: ispublic
        in: query
        description: whether this is a public HSM profile available to all users globally (root admin only). Default is false
        schema:
          type: boolean
      - name: projectid
        in: query
        description: the ID of the project to add the HSM profile for
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: protocol
        in: query
        description: the protocol of the HSM profile (PKCS11, KMIP, etc.). Default is 'pkcs11'
        schema:
          type: string
          maxLength: 255
      - name: vendorname
        in: query
        description: the vendor name of the HSM
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: the zone ID where the HSM profile is available. If null, global scope (for admin only)
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createHSMProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createhsmprofileresponse:
                    oneOf:
                    - &id054
                      $ref: '#/components/schemas/HSMProfile'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id054
                        - type: array
                          items: *id054
                required:
                - createhsmprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createhsmprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createhsmprofileresponse
      x-cloudstack-command: createHSMProfile
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - listHSMProfiles
      - updateHSMProfile
  /createInstanceGroup:
    get:
      operationId: createInstanceGroup
      summary: Creates an Instance group
      tags:
      - InstanceGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createInstanceGroup
          default: createInstanceGroup
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the Instance group
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: The account of the Instance group. The account parameter must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID of account owning the Instance group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: projectid
        in: query
        description: The project of the Instance group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `createInstanceGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createinstancegroupresponse:
                    oneOf:
                    - &id055
                      $ref: '#/components/schemas/InstanceGroup'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id055
                        - type: array
                          items: *id055
                required:
                - createinstancegroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createinstancegroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createinstancegroupresponse
      x-cloudstack-command: createInstanceGroup
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateInstanceGroup
  /createInternalLoadBalancerElement:
    get:
      operationId: createInternalLoadBalancerElement
      summary: Create an Internal Load Balancer element.
      description: |-
        Create an Internal Load Balancer element.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - InternalLoadBalancerElement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createInternalLoadBalancerElement
          default: createInternalLoadBalancerElement
      - $ref: '#/components/parameters/response'
      - name: nspid
        in: query
        description: The network service provider ID of the internal load balancer element
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetworkServiceProvider
        - listNetworkServiceProviders
      responses:
        '200':
          description: Successful invocation of `createInternalLoadBalancerElement`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createinternalloadbalancerelementresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createinternalloadbalancerelementresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createinternalloadbalancerelementresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createinternalloadbalancerelementresponse
      x-cloudstack-command: createInternalLoadBalancerElement
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - configureInternalLoadBalancerElement
      - listInternalLoadBalancerElements
      x-cloudstack-jobresult-schema: '#/components/schemas/InternalLoadBalancerElement'
  /createIpForwardingRule:
    get:
      operationId: createIpForwardingRule
      summary: Creates an IP forwarding rule
      description: |-
        Creates an IP forwarding rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - IpForwardingRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createIpForwardingRule
          default: createIpForwardingRule
      - $ref: '#/components/parameters/response'
      - name: ipaddressid
        in: query
        description: The public IP address ID of the forwarding rule, already associated via associateIp
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - updateIpAddress
      - name: protocol
        in: query
        description: The protocol for the rule. Valid values are TCP or UDP.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: startport
        in: query
        description: The start port for the rule
        required: true
        schema:
          type: integer
          format: int32
      - name: cidrlist
        in: query
        description: The CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,). This parameter is deprecated. Do not use. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: endport
        in: query
        description: The end port for the rule
        schema:
          type: integer
          format: int32
      - name: openfirewall
        in: query
        description: If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `createIpForwardingRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createipforwardingruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createipforwardingruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createipforwardingruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createipforwardingruleresponse
      x-cloudstack-command: createIpForwardingRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - createPortForwardingRule
      - updatePortForwardingRule
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv6FirewallRule'
  /createIpv4SubnetForGuestNetwork:
    get:
      operationId: createIpv4SubnetForGuestNetwork
      summary: Creates a IPv4 subnet for guest networks.
      description: |-
        Creates a IPv4 subnet for guest networks.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createIpv4SubnetForGuestNetwork
          default: createIpv4SubnetForGuestNetwork
      - $ref: '#/components/parameters/response'
      - name: parentid
        in: query
        description: The zone Ipv4 subnet which the IPv4 subnet belongs to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - dedicateIpv4SubnetForZone
        - listIpv4SubnetsForZone
      - name: cidrsize
        in: query
        description: the CIDR size of IPv4 network. This is mutually exclusive with subnet.
        schema:
          type: integer
          format: int32
      - name: subnet
        in: query
        description: The CIDR of this Ipv4 subnet.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createIpv4SubnetForGuestNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createipv4subnetforguestnetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createipv4subnetforguestnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createipv4subnetforguestnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createipv4subnetforguestnetworkresponse
      x-cloudstack-command: createIpv4SubnetForGuestNetwork
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/CreateIpv4SubnetForGuestNetworkResult'
  /createIpv4SubnetForZone:
    get:
      operationId: createIpv4SubnetForZone
      summary: Creates a IPv4 subnet for a zone.
      description: |-
        Creates a IPv4 subnet for a zone.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Ipv4SubnetForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createIpv4SubnetForZone
          default: createIpv4SubnetForZone
      - $ref: '#/components/parameters/response'
      - name: subnet
        in: query
        description: The CIDR of the IPv4 subnet.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: UUID of the zone which the IPv4 subnet belongs to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: account
        in: query
        description: account who will own the IPv4 subnet
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: domain ID of the account owning the IPv4 subnet
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: projectid
        in: query
        description: project who will own the IPv4 subnet
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `createIpv4SubnetForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createipv4subnetforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createipv4subnetforzoneresponse
      x-cloudstack-command: createIpv4SubnetForZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - dedicateIpv4SubnetForZone
      - listIpv4SubnetsForZone
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv4SubnetForZone'
  /createIpv6FirewallRule:
    get:
      operationId: createIpv6FirewallRule
      summary: Creates an IPv6 firewall rule in the given Network (the Network must not belong to VPC)
      description: |-
        Creates an IPv6 firewall rule in the given Network (the Network must not belong to VPC)

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Ipv6FirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createIpv6FirewallRule
          default: createIpv6FirewallRule
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: The Network of the Instance the Ipv6 firewall rule will be created for
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: protocol
        in: query
        description: The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number
        required: true
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: The source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: destcidrlist
        in: query
        description: The destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: endport
        in: query
        description: The ending port of Ipv6 firewall rule
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end User or not
        schema:
          type: boolean
      - name: icmpcode
        in: query
        description: Error code for this ICMP message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: Type of the ICMP message being sent
        schema:
          type: integer
          format: int32
      - name: startport
        in: query
        description: The starting port of Ipv6 firewall rule
        schema:
          type: integer
          format: int32
      - name: traffictype
        in: query
        description: The traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createIpv6FirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createipv6firewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createipv6firewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createipv6firewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createipv6firewallruleresponse
      x-cloudstack-command: createIpv6FirewallRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - createIpForwardingRule
      - createPortForwardingRule
      - createRoutingFirewallRule
      - listPortForwardingRules
      - listRoutingFirewallRules
      - updateIpv6FirewallRule
      - updatePortForwardingRule
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv6FirewallRule'
  /createKMSKey:
    get:
      operationId: createKMSKey
      summary: Creates a new KMS key (Key Encryption Key) for encryption
      tags:
      - KMSKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createKMSKey
          default: createKMSKey
      - $ref: '#/components/parameters/response'
      - name: hsmprofileid
        in: query
        description: ID of HSM profile to create key in
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: name
        in: query
        description: Name of the KMS key
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: Zone ID where the key will be valid
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: Account name (for creating keys for child accounts - requires domain admin or admin)
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: Description of the KMS key
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Domain ID (for creating keys for child accounts - requires domain admin or admin)
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: keybits
        in: query
        description: 'Key size in bits: 128, 192, or 256 (default: 256)'
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: ID of the project to create the KMS key for
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createKMSKey`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createkmskeyresponse:
                    oneOf:
                    - &id056
                      $ref: '#/components/schemas/KMSKey'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id056
                        - type: array
                          items: *id056
                required:
                - createkmskeyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createkmskeyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createkmskeyresponse
      x-cloudstack-command: createKMSKey
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - updateKMSKey
  /createKubernetesCluster:
    get:
      operationId: createKubernetesCluster
      summary: Creates a Kubernetes cluster
      description: |-
        Creates a Kubernetes cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createKubernetesCluster
          default: createKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name for the Kubernetes cluster
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: Availability zone in which Kubernetes cluster to be launched
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: An optional Account for the Instance. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: asnumber
        in: query
        description: the AS Number of the network
        schema:
          type: integer
          format: int64
      - name: clustertype
        in: query
        description: 'Type of the cluster: CloudManaged, ExternalManaged. The default value is CloudManaged.'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: cniconfigdetails
        in: query
        description: 'used to specify the parameters values for the variables in userdata. Example: cniconfigdetails[0].key=accesskey&cniconfigdetails[0].value=s389ddssaa&cniconfigdetails[1].key=secretkey&cniconfigdetails[1].value=8dshfsss. Map parameter. CloudStack expects it index-encoded as `cniconfigdetails[0].key=k&cniconfigdetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: cniconfigurationid
        in: query
        description: the ID of the Userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: controlnodes
        in: query
        description: Number of Kubernetes cluster control nodes, default is 1
        schema:
          type: integer
          format: int64
      - name: description
        in: query
        description: Description for the Kubernetes cluster
        schema:
          type: string
          maxLength: 255
      - name: dockerregistrypassword
        in: query
        description: Password for the docker image private registry
        schema:
          type: string
          maxLength: 255
      - name: dockerregistryurl
        in: query
        description: URL for the docker image private registry
        schema:
          type: string
          maxLength: 255
      - name: dockerregistryusername
        in: query
        description: User name for the docker image private registry
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the Instance. If the Account parameter is used, domainId must also be used. Hosts dedicated to the specified domain will be used for deploying the cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: enablecsi
        in: query
        description: if true, setups up CloudStack CSI driver
        schema:
          type: boolean
        x-cloudstack-since: 4.22.0
      - name: etcdnodes
        in: query
        description: (Optional) Number of Kubernetes cluster etcd nodes, default is 0.In case the number is greater than 0, etcd nodes are separate from master nodes and are provisioned accordingly
        schema:
          type: integer
          format: int64
        x-cloudstack-since: 4.21.0
      - name: externalloadbalanceripaddress
        in: query
        description: External load balancer IP address while using shared network with Kubernetes HA cluster
        schema:
          type: string
          maxLength: 255
      - name: hypervisor
        in: query
        description: the hypervisor on which the CKS cluster is to be deployed. This is required if the zone in which the CKS cluster is being deployed has clusters with different hypervisor types.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: keypair
        in: query
        description: Name of the SSH key pair used to login to the Instances
        schema:
          type: string
          maxLength: 255
      - name: kubernetesversionid
        in: query
        description: Kubernetes version with which cluster to be launched
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - getUploadParamsForKubernetesSupportedVersion
        - listKubernetesSupportedVersions
      - name: masternodes
        in: query
        description: Number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.
        schema:
          type: integer
          format: int64
      - name: networkid
        in: query
        description: Network in which Kubernetes cluster is to be launched
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: nodeaffinitygroups
        in: query
        description: (Optional) Node Type to Affinity Group ID mapping. If provided, VMs of each node type will be added to the specified affinity group. Map parameter. CloudStack expects it index-encoded as `nodeaffinitygroups[0].key=k&nodeaffinitygroups[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.23.0
      - name: nodeofferings
        in: query
        description: (Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter. Map parameter. CloudStack expects it index-encoded as `nodeofferings[0].key=k&nodeofferings[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: noderootdisksize
        in: query
        description: Root disk size in GB for each node
        schema:
          type: integer
          format: int64
      - name: nodetemplates
        in: query
        description: '(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template. Map parameter. CloudStack expects it index-encoded as `nodetemplates[0].key=k&nodetemplates[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: projectid
        in: query
        description: Deploy cluster for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: serviceofferingid
        in: query
        description: The ID of the service offering for the Instances in the cluster.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: size
        in: query
        description: Number of Kubernetes cluster worker nodes
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `createKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createkubernetesclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createkubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createkubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createkubernetesclusterresponse
      x-cloudstack-command: createKubernetesCluster
      x-cloudstack-async: true
      x-cloudstack-related:
      - startKubernetesCluster
      - updateKubernetesClusterAffinityGroups
      x-cloudstack-jobresult-schema: '#/components/schemas/KubernetesCluster'
  /createLBHealthCheckPolicy:
    get:
      operationId: createLBHealthCheckPolicy
      summary: Creates a load balancer health check policy
      description: |-
        Creates a load balancer health check policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LBHealthCheckPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createLBHealthCheckPolicy
          default: createLBHealthCheckPolicy
      - $ref: '#/components/parameters/response'
      - name: lbruleid
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: description
        in: query
        description: The description of the load balancer health check policy
        schema:
          type: string
          maxLength: 255
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: healthythreshold
        in: query
        description: Number of consecutive health check success before declaring an Instance healthy
        schema:
          type: integer
          format: int32
      - name: intervaltime
        in: query
        description: Amount of time between health checks (1 sec - 20940 sec)
        schema:
          type: integer
          format: int32
      - name: pingpath
        in: query
        description: HTTP ping path
        schema:
          type: string
          maxLength: 255
      - name: responsetimeout
        in: query
        description: Time to wait when receiving a response from the health check (2sec - 60 sec)
        schema:
          type: integer
          format: int32
      - name: unhealthythreshold
        in: query
        description: Number of consecutive health check failures before declaring an Instance unhealthy
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `createLBHealthCheckPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createlbhealthcheckpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createlbhealthcheckpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createlbhealthcheckpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createlbhealthcheckpolicyresponse
      x-cloudstack-command: createLBHealthCheckPolicy
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-jobresult-schema: '#/components/schemas/LBHealthCheckPolicy'
  /createLBStickinessPolicy:
    get:
      operationId: createLBStickinessPolicy
      summary: Creates a load balancer stickiness policy
      description: |-
        Creates a load balancer stickiness policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LBStickinessPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createLBStickinessPolicy
          default: createLBStickinessPolicy
      - $ref: '#/components/parameters/response'
      - name: lbruleid
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: methodname
        in: query
        description: Name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the load balancer stickiness policy
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: The description of the load balancer stickiness policy
        schema:
          type: string
          maxLength: 255
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: param
        in: query
        description: 'Param list. Example: param[0].name=cookiename&param[0].value=LBCookie. Map parameter. CloudStack expects it index-encoded as `param[0].key=k&param[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `createLBStickinessPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createlbstickinesspolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createlbstickinesspolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createlbstickinesspolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createlbstickinesspolicyresponse
      x-cloudstack-command: createLBStickinessPolicy
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/LBStickinessPolicy'
  /createLoadBalancer:
    get:
      operationId: createLoadBalancer
      summary: Creates an internal load balancer
      description: |-
        Creates an internal load balancer

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createLoadBalancer
          default: createLoadBalancer
      - $ref: '#/components/parameters/response'
      - name: algorithm
        in: query
        description: Load balancer algorithm (source, roundrobin, leastconn)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: instanceport
        in: query
        description: The TCP port of the Instance where the network traffic will be load balanced to
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: Name of the load balancer
        required: true
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: The guest Network the load balancer will be created for
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: scheme
        in: query
        description: The load balancer scheme. Supported value in this release is Internal
        required: true
        schema:
          type: string
          maxLength: 255
      - name: sourceipaddressnetworkid
        in: query
        description: The Network ID of the source IP address
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: sourceport
        in: query
        description: The source port the Network traffic will be load balanced from
        required: true
        schema:
          type: integer
          format: int32
      - name: description
        in: query
        description: The description of the load balancer
        schema:
          type: string
          maxLength: 4096
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: sourceipaddress
        in: query
        description: The source IP address the network traffic will be load balanced from
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createLoadBalancer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createloadbalancerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createloadbalancerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createloadbalancerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createloadbalancerresponse
      x-cloudstack-command: createLoadBalancer
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-jobresult-schema: '#/components/schemas/LoadBalancer'
  /createLoadBalancerRule:
    get:
      operationId: createLoadBalancerRule
      summary: Creates a load balancer rule
      description: |-
        Creates a load balancer rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createLoadBalancerRule
          default: createLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: algorithm
        in: query
        description: Load balancer algorithm (source, roundrobin, leastconn)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the load balancer rule
        required: true
        schema:
          type: string
          maxLength: 255
      - name: privateport
        in: query
        description: The private port of the private IP address/Instance where the network traffic will be load balanced to
        required: true
        schema:
          type: integer
          format: int32
      - name: publicport
        in: query
        description: The public port from where the network traffic will be load balanced from
        required: true
        schema:
          type: integer
          format: int32
      - name: account
        in: query
        description: The Account associated with the load balancer. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: The source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). By default, all CIDRs are allowed. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.18.0.0
      - name: description
        in: query
        description: The description of the load balancer rule
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: The domain ID associated with the load balancer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: networkid
        in: query
        description: The guest Network this rule will be created for. Required when public IP address is not associated with any Guest Network yet (VPC case)
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: openfirewall
        in: query
        description: If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when LB rule is being created for VPC guest network 2) in all other cases defaulted to true
        schema:
          type: boolean
      - name: protocol
        in: query
        description: The protocol for the LB such as TCP, UDP, TCP-proxy or SSL.
        schema:
          type: string
          maxLength: 255
      - name: publicipid
        in: query
        description: Public IP address ID from where the network traffic will be load balanced from
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      - name: zoneid
        in: query
        description: Zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createloadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createloadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createloadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createloadbalancerruleresponse
      x-cloudstack-command: createLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - listLoadBalancerRules
      - updateLoadBalancerRule
      x-cloudstack-jobresult-schema: '#/components/schemas/LoadBalancerRule'
  /createManagementNetworkIpRange:
    get:
      operationId: createManagementNetworkIpRange
      summary: Creates a Management network IP range.
      description: |-
        Creates a Management network IP range.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ManagementNetworkIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createManagementNetworkIpRange
          default: createManagementNetworkIpRange
      - $ref: '#/components/parameters/response'
      - name: gateway
        in: query
        description: The gateway for the management network.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The netmask for the management network.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: UUID of POD, where the IP range belongs to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: startip
        in: query
        description: The starting IP address.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: endip
        in: query
        description: The ending IP address.
        schema:
          type: string
          maxLength: 255
      - name: forsystemvms
        in: query
        description: Specify if range is dedicated for CPVM and SSVM.
        schema:
          type: boolean
      - name: vlan
        in: query
        description: Optional. The vlan id the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createManagementNetworkIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createmanagementnetworkiprangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createmanagementnetworkiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createmanagementnetworkiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createmanagementnetworkiprangeresponse
      x-cloudstack-command: createManagementNetworkIpRange
      x-cloudstack-async: true
      x-cloudstack-since: 4.11.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/Pod'
  /createNetwork:
    get:
      operationId: createNetwork
      summary: Creates a Network
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createNetwork
          default: createNetwork
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: networkofferingid
        in: query
        description: The network offering ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listNetworkOfferings
      - name: zoneid
        in: query
        description: The zone ID for the network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: Account that will own the network. Account should be under the selected domain
        schema:
          type: string
          maxLength: 255
      - name: aclid
        in: query
        description: Network ACL ID associated for the network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
      - name: acltype
        in: query
        description: Access control type; supported values are Account and domain. In 3.0 all shared networks should have aclType=Domain, and all isolated networks - Account. Account means that only the Account owner can use the network, domain - all accounts in the domain can use the network
        schema:
          type: string
          maxLength: 255
      - name: asnumber
        in: query
        description: the AS Number of the network
        schema:
          type: integer
          format: int64
        x-cloudstack-since: 4.20.0
      - name: associatednetworkid
        in: query
        description: The network this network is associated to. only available if create a Shared network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.17.0
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: bgppeerids
        in: query
        description: IDs of the Bgp Peer for the Network. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.20.0
      - name: bypassvlanoverlapcheck
        in: query
        description: When true bypasses VLAN ID/range overlap check during Network creation for shared and L2 Networks
        schema:
          type: boolean
      - name: cidrsize
        in: query
        description: the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.20.0
      - name: displaynetwork
        in: query
        description: An optional field, whether to the display the network to the end User or not.
        schema:
          type: boolean
      - name: displaytext
        in: query
        description: The display text of the network
        schema:
          type: string
          maxLength: 255
      - name: dns1
        in: query
        description: The first IPv4 DNS for the network
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: dns2
        in: query
        description: The second IPv4 DNS for the network
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: domainid
        in: query
        description: Domain ID of the account owning a network. If the Account is not specified, but the acltype is Account or not specified, the Network will be automatically assigned to the caller account and domain. To create a Network under the domain without linking it to any account, make sure to include acltype=Domain parameter in the api call. If Account is not specified, but acltype is Domain, the network will be created for the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: endip
        in: query
        description: The ending IP address in the Network IP range. If not specified, will be defaulted to startIP
        schema:
          type: string
          maxLength: 255
      - name: endipv6
        in: query
        description: The ending IPv6 address in the IPv6 network range
        schema:
          type: string
          maxLength: 255
      - name: externalid
        in: query
        description: ID of the network in an external system.
        schema:
          type: string
          maxLength: 255
      - name: gateway
        in: query
        description: The gateway of the Network. Required for shared networks and isolated networks when it belongs to VPC
        schema:
          type: string
          maxLength: 255
      - name: hideipaddressusage
        in: query
        description: When true IP address usage for the Network will not be exported by the listUsageRecords API
        schema:
          type: boolean
      - name: ip6cidr
        in: query
        description: The CIDR of IPv6 network, must be at least /64
        schema:
          type: string
          maxLength: 255
      - name: ip6dns1
        in: query
        description: The first IPv6 DNS for the network
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: ip6dns2
        in: query
        description: The second IPv6 DNS for the network
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: ip6gateway
        in: query
        description: The gateway of the IPv6 network. Required for Shared networks
        schema:
          type: string
          maxLength: 255
      - name: isolatedpvlan
        in: query
        description: The isolated private VLAN for this Network
        schema:
          type: string
          maxLength: 255
      - name: isolatedpvlantype
        in: query
        description: The isolated private VLAN type for this network
        schema:
          type: string
          maxLength: 255
      - name: keepmacaddressonpublicnic
        in: query
        description: Indicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have  a new MAC address.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: netmask
        in: query
        description: The netmask of the Network. Required for shared networks and isolated networks when it belongs to VPC
        schema:
          type: string
          maxLength: 255
      - name: networkdomain
        in: query
        description: Network domain
        schema:
          type: string
          maxLength: 255
      - name: physicalnetworkid
        in: query
        description: The physical Network ID the network belongs to
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: privatemtu
        in: query
        description: MTU to be configured on the network VR's private interface(s)
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.18.0
      - name: projectid
        in: query
        description: An optional project for the network
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: publicmtu
        in: query
        description: MTU to be configured on the network VR's public facing interfaces
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.18.0
      - name: routerip
        in: query
        description: IPv4 address to be assigned to a router in a shared Network
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.16'
      - name: routeripv6
        in: query
        description: IPv6 address to be assigned to a router in a shared Network
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.16'
      - name: sourcenatipaddress
        in: query
        description: "IPV4 address to be assigned to the public interface of the network router. This address will be used as source NAT address for the network. \nIf an address is given and it cannot be acquired, an error will be returned and the network won´t be implemented,"
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.19'
      - name: startip
        in: query
        description: The beginning IP address in the Network IP range
        schema:
          type: string
          maxLength: 255
      - name: startipv6
        in: query
        description: The beginning IPv6 address in the IPv6 network range
        schema:
          type: string
          maxLength: 255
      - name: subdomainaccess
        in: query
        description: Defines whether to allow subdomains to use networks dedicated to their parent domain(s). Should be used with aclType=Domain, defaulted to allow.subdomain.network.access global config if not specified
        schema:
          type: boolean
      - name: tungstenvirtualrouteruuid
        in: query
        description: Tungsten-Fabric virtual router the network belongs to
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: The ID or VID of the network
        schema:
          type: string
          maxLength: 255
      - name: vpcid
        in: query
        description: The VPC network belongs to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `createNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkresponse:
                    oneOf:
                    - &id057
                      $ref: '#/components/schemas/Network'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id057
                        - type: array
                          items: *id057
                required:
                - createnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createnetworkresponse
      x-cloudstack-command: createNetwork
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetwork
      - listNetworks
      - migrateNetwork
      - updateNetwork
  /createNetworkACL:
    get:
      operationId: createNetworkACL
      summary: Creates a ACL rule in the given Network (the Network has to belong to VPC)
      description: |-
        Creates a ACL rule in the given Network (the Network has to belong to VPC)

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkACL
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createNetworkACL
          default: createNetworkACL
      - $ref: '#/components/parameters/response'
      - name: protocol
        in: query
        description: The protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number
        required: true
        schema:
          type: string
          maxLength: 255
      - name: aclid
        in: query
        description: The network of the Instance the ACL will be created for
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
      - name: action
        in: query
        description: ACL entry action, allow or deny
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: The CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: endport
        in: query
        description: The ending port of ACL
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: icmpcode
        in: query
        description: Error code for this ICMP message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: Type of the ICMP message being sent
        schema:
          type: integer
          format: int32
      - name: networkid
        in: query
        description: The Network of the Instance the ACL will be created for
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: number
        in: query
        description: The number of the ACL item, its ordering
        schema:
          type: integer
          format: int32
      - name: reason
        in: query
        description: A description indicating why the ACL rule is required.
        schema:
          type: string
          maxLength: 255
      - name: startport
        in: query
        description: The starting port of ACL
        schema:
          type: integer
          format: int32
      - name: traffictype
        in: query
        description: The traffic type for the ACL,can be ingress or egress, defaulted to ingress if not specified
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createNetworkACL`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkaclresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createnetworkaclresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkaclresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createnetworkaclresponse
      x-cloudstack-command: createNetworkACL
      x-cloudstack-async: true
      x-cloudstack-related:
      - moveNetworkAclItem
      - updateNetworkACLItem
      x-cloudstack-jobresult-schema: '#/components/schemas/NetworkACL'
  /createNetworkACLList:
    get:
      operationId: createNetworkACLList
      summary: Creates a Network ACL.
      description: |-
        Creates a Network ACL. If no VPC is given, then it creates a global ACL that can be used by everyone.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkACLList
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createNetworkACLList
          default: createNetworkACLList
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the Network ACL list
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: Description of the Network ACL list
        schema:
          type: string
          maxLength: 255
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the list to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: vpcid
        in: query
        description: ID of the VPC associated with this Network ACL list
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `createNetworkACLList`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkacllistresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createnetworkacllistresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkacllistresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createnetworkacllistresponse
      x-cloudstack-command: createNetworkACLList
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/NetworkACLList'
  /createNetworkOffering:
    get:
      operationId: createNetworkOffering
      summary: Creates a network offering.
      tags:
      - NetworkOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createNetworkOffering
          default: createNetworkOffering
      - $ref: '#/components/parameters/response'
      - name: guestiptype
        in: query
        description: 'Guest type of the network offering: Shared or Isolated'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the network offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: traffictype
        in: query
        description: The traffic type for the network offering. Supported type in current release is GUEST only
        required: true
        schema:
          type: string
          maxLength: 255
      - name: availability
        in: query
        description: The availability of network offering. The default value is Optional.  Another value is Required, which will make it as the default network offering for new networks
        schema:
          type: string
          maxLength: 255
      - name: conservemode
        in: query
        description: True if the network offering is IP conserve mode enabled
        schema:
          type: boolean
      - name: details
        in: query
        description: Network offering details in key/value pairs. Supported keys are internallbprovider/publiclbprovider with service provider as a value, and promiscuousmode/macaddresschanges/forgedtransmits with true/false as value to accept/reject the security settings if available for a nic/portgroup. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.2.0
      - name: displaytext
        in: query
        description: The display text of the network offering, defaults to the value of 'name'.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: egressdefaultpolicy
        in: query
        description: True if guest network default egress policy is allow; false if default egress policy is deny
        schema:
          type: boolean
      - name: enable
        in: query
        description: Set to true if the offering is to be enabled during creation. Default is false
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: fornsx
        in: query
        description: true if network offering is meant to be used for NSX, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: fortungsten
        in: query
        description: True if network offering is meant to be used for Tungsten-Fabric, false otherwise.
        schema:
          type: boolean
      - name: forvpc
        in: query
        description: True if network offering is meant to be used for VPC, false otherwise.
        schema:
          type: boolean
      - name: internetprotocol
        in: query
        description: The internet protocol of network offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create a network offering that supports both IPv4 and IPv6
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.17.0
      - name: ispersistent
        in: query
        description: True if network offering supports persistent networks; defaulted to false if not specified
        schema:
          type: boolean
      - name: keepaliveenabled
        in: query
        description: If true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.
        schema:
          type: boolean
      - name: maxconnections
        in: query
        description: Maximum number of concurrent connections supported by the Network offering
        schema:
          type: integer
          format: int32
      - name: networkmode
        in: query
        description: 'Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: networkrate
        in: query
        description: Data transfer rate in megabits per second allowed
        schema:
          type: integer
          format: int32
      - name: nsxsupportlb
        in: query
        description: True if network offering for NSX network offering supports Load balancer service.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: nsxsupportsinternallb
        in: query
        description: True if network offering for NSX network offering supports Internal Load balancer service.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: provider
        in: query
        description: Name of the provider providing the service
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: routingmode
        in: query
        description: 'the routing mode for the network offering. Supported types are: Static or Dynamic.'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: servicecapabilitylist
        in: query
        description: Desired service capabilities as part of network offering. Map parameter. CloudStack expects it index-encoded as `servicecapabilitylist[0].key=k&servicecapabilitylist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: serviceofferingid
        in: query
        description: The service offering ID used by virtual router provider
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: serviceproviderlist
        in: query
        description: Provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network. Map parameter. CloudStack expects it index-encoded as `serviceproviderlist[0].key=k&serviceproviderlist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: specifyasnumber
        in: query
        description: true if network offering supports choosing AS number
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: specifyipranges
        in: query
        description: True if network offering supports specifying ip ranges; defaulted to false if not specified
        schema:
          type: boolean
      - name: specifyvlan
        in: query
        description: True if network offering supports VLANs
        schema:
          type: boolean
      - name: supportedservices
        in: query
        description: Services supported by the network offering. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: tags
        in: query
        description: The tags for the network offering.
        schema:
          type: string
          maxLength: 4096
      - name: zoneid
        in: query
        description: The ID of the containing zone(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createNetworkOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkofferingresponse:
                    oneOf:
                    - &id058
                      $ref: '#/components/schemas/NetworkOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id058
                        - type: array
                          items: *id058
                required:
                - createnetworkofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createnetworkofferingresponse
      x-cloudstack-command: createNetworkOffering
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - listNetworkOfferings
  /createNetworkPermissions:
    get:
      operationId: createNetworkPermissions
      summary: Updates network permissions.
      tags:
      - NetworkPermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createNetworkPermissions
          default: createNetworkPermissions
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: The network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: accountids
        in: query
        description: A comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createAccount
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      - name: accounts
        in: query
        description: A comma delimited list of accounts within owner's domain. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: projectids
        in: query
        description: A comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `createNetworkPermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkpermissionsresponse:
                    oneOf:
                    - &id059
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id059
                        - type: array
                          items: *id059
                required:
                - createnetworkpermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createnetworkpermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createnetworkpermissionsresponse
      x-cloudstack-command: createNetworkPermissions
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /createPhysicalNetwork:
    get:
      operationId: createPhysicalNetwork
      summary: Creates a physical Network
      description: |-
        Creates a physical Network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PhysicalNetwork
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createPhysicalNetwork
          default: createPhysicalNetwork
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the physical Network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID for the physical Network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: broadcastdomainrange
        in: query
        description: The broadcast domain range for the physical Network[Pod or Zone]. In Acton release it can be Zone only in Advance zone, and Pod in Basic
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Domain ID of the Account owning a physical Network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: isolationmethods
        in: query
        description: The isolation method for the physical Network[VLAN/VXLAN/GRE/STT/BCF_SEGMENT/SSP/ODL/L3VPN/VCS/NSX/NETRIS]. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: networkspeed
        in: query
        description: The speed for the physical Network[1G/10G]
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: Tag the physical Network. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: vlan
        in: query
        description: The VLAN for the physical Network
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createPhysicalNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createphysicalnetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createphysicalnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createphysicalnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createphysicalnetworkresponse
      x-cloudstack-command: createPhysicalNetwork
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - listPhysicalNetworks
      - updatePhysicalNetwork
      x-cloudstack-jobresult-schema: '#/components/schemas/PhysicalNetwork'
  /createPod:
    get:
      operationId: createPod
      summary: Creates a new Pod.
      tags:
      - Pod
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createPod
          default: createPod
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the Pod
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID in which the Pod will be created
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: allocationstate
        in: query
        description: Allocation state of this Pod for allocation of new resources
        schema:
          type: string
          maxLength: 255
      - name: endip
        in: query
        description: The ending IP address for the Pod
        schema:
          type: string
          maxLength: 255
      - name: gateway
        in: query
        description: The gateway for the Pod
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The netmask for the Pod
        schema:
          type: string
          maxLength: 255
      - name: startip
        in: query
        description: The starting IP address for the Pod
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroups
        in: query
        description: comma separated list of storage access groups for the hosts in the pod. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
      responses:
        '200':
          description: Successful invocation of `createPod`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createpodresponse:
                    oneOf:
                    - &id060
                      $ref: '#/components/schemas/Pod'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id060
                        - type: array
                          items: *id060
                required:
                - createpodresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createpodresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createpodresponse
      x-cloudstack-command: createPod
      x-cloudstack-async: false
      x-cloudstack-related:
      - createManagementNetworkIpRange
      - listPods
  /createPortForwardingRule:
    get:
      operationId: createPortForwardingRule
      summary: Creates a port forwarding rule
      description: |-
        Creates a port forwarding rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PortForwardingRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createPortForwardingRule
          default: createPortForwardingRule
      - $ref: '#/components/parameters/response'
      - name: ipaddressid
        in: query
        description: The IP address ID of the port forwarding rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - updateIpAddress
      - name: privateport
        in: query
        description: The starting port of port forwarding rule's private port range
        required: true
        schema:
          type: integer
          format: int32
      - name: protocol
        in: query
        description: The protocol for the port forwarding rule. Valid values are TCP or UDP.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: publicport
        in: query
        description: The starting port of port forwarding rule's public port range
        required: true
        schema:
          type: integer
          format: int32
      - name: virtualmachineid
        in: query
        description: The ID of the  Instance for the port forwarding rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: cidrlist
        in: query
        description: The source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: networkid
        in: query
        description: The Network of the Instance the port forwarding rule will be created for. Required when public IP address is not associated with any guest network yet (VPC case).
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: openfirewall
        in: query
        description: If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. If not specified 1) defaulted to false when PF rule is being created for VPC guest network 2) in all other cases defaulted to true
        schema:
          type: boolean
      - name: privateendport
        in: query
        description: The ending port of port forwarding rule's private port range
        schema:
          type: integer
          format: int32
      - name: publicendport
        in: query
        description: The ending port of port forwarding rule's private port range
        schema:
          type: integer
          format: int32
      - name: vmguestip
        in: query
        description: Instance guest NIC secondary IP address for the port forwarding rule
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createPortForwardingRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createportforwardingruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createportforwardingruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createportforwardingruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createportforwardingruleresponse
      x-cloudstack-command: createPortForwardingRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - updatePortForwardingRule
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv6FirewallRule'
  /createPortableIpRange:
    get:
      operationId: createPortableIpRange
      summary: Adds a range of portable public IP's to a region
      description: |-
        Adds a range of portable public IP's to a region

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PortableIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createPortableIpRange
          default: createPortableIpRange
      - $ref: '#/components/parameters/response'
      - name: endip
        in: query
        description: The ending IP address in the portable IP range
        required: true
        schema:
          type: string
          maxLength: 255
      - name: gateway
        in: query
        description: The gateway for the portable IP range
        required: true
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The netmask of the portable IP range
        required: true
        schema:
          type: string
          maxLength: 255
      - name: regionid
        in: query
        description: Id of the Region
        required: true
        schema:
          type: integer
          format: int32
      - name: startip
        in: query
        description: The beginning IP address in the portable IP range
        required: true
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: VLAN id, if not specified defaulted to untagged
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createPortableIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createportableiprangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createportableiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createportableiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createportableiprangeresponse
      x-cloudstack-command: createPortableIpRange
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-jobresult-schema: '#/components/schemas/PortableIpRange'
  /createPrivateGateway:
    get:
      operationId: createPrivateGateway
      summary: Creates a private gateway
      description: |-
        Creates a private gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PrivateGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createPrivateGateway
          default: createPrivateGateway
      - $ref: '#/components/parameters/response'
      - name: gateway
        in: query
        description: The Gateway of the Private Gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ipaddress
        in: query
        description: The IP address of the Private Gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The Netmask of the Private Gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: vpcid
        in: query
        description: The VPC Network belongs to
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: aclid
        in: query
        description: The ID of the Network ACL
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
        - listNetworkACLLists
      - name: associatednetworkid
        in: query
        description: The Isolated Network this private gateway is associated to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.17.0
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: bypassvlanoverlapcheck
        in: query
        description: When true bypasses VLAN id/range overlap check during private gateway creation
        schema:
          type: boolean
      - name: networkofferingid
        in: query
        description: The UUID of the Network offering to use for the private gateways Network connection
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkOffering
        - listNetworkOfferings
        - updateNetworkOffering
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID the network belongs to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: sourcenatsupported
        in: query
        description: 'Source NAT supported value. Default value: false. When ''true'', the source NAT is enabled on the private gateway ''false'': sourcenat is not supported'
        schema:
          type: boolean
      - name: vlan
        in: query
        description: The network implementation uri for the private gateway
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createPrivateGateway`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createprivategatewayresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createprivategatewayresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createprivategatewayresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createprivategatewayresponse
      x-cloudstack-command: createPrivateGateway
      x-cloudstack-async: true
      x-cloudstack-since: 4.17.0
      x-cloudstack-related:
      - createPrivateGateway
      - listPrivateGateways
      x-cloudstack-jobresult-schema: '#/components/schemas/PrivateGateway'
  /createProject:
    get:
      operationId: createProject
      summary: Creates a project
      description: |-
        Creates a project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createProject
          default: createProject
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the project
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: Account who will be Admin for the project
        schema:
          type: string
          maxLength: 255
      - name: accountid
        in: query
        description: ID of the Account owning a project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - markDefaultZoneForAccount
        - updateAccount
      - name: displaytext
        in: query
        description: The display text of the project, defaults to the 'name´.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Domain ID of the Account owning a project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: userid
        in: query
        description: User ID of the Account to be assigned as owner of the project i.e., Project Admin
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.15.0
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
        - lockUser
      responses:
        '200':
          description: Successful invocation of `createProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createprojectresponse
      x-cloudstack-command: createProject
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/Project'
  /createProjectRole:
    get:
      operationId: createProjectRole
      summary: Creates a Project role
      tags:
      - ProjectRole
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createProjectRole
          default: createProjectRole
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Creates a project role with this unique name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: ID of project where role is being created
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: description
        in: query
        description: The description of the Project role
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createProjectRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createprojectroleresponse:
                    oneOf:
                    - &id061
                      $ref: '#/components/schemas/ProjectRole'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id061
                        - type: array
                          items: *id061
                required:
                - createprojectroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createprojectroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createprojectroleresponse
      x-cloudstack-command: createProjectRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
      x-cloudstack-related:
      - listProjectRoles
      - updateProjectRole
  /createProjectRolePermission:
    get:
      operationId: createProjectRolePermission
      summary: Adds API permissions to a project role
      tags:
      - ProjectRolePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createProjectRolePermission
          default: createProjectRolePermission
      - $ref: '#/components/parameters/response'
      - name: permission
        in: query
        description: 'The rule permission, allow or deny. Default: deny.'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: ID of project where project role permission is to be created
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      - name: projectroleid
        in: query
        description: ID of the project role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectRoles
        - updateProjectRole
      - name: rule
        in: query
        description: The API name or wildcard rule such as list*
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: The description of the role permission
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createProjectRolePermission`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createprojectrolepermissionresponse:
                    oneOf:
                    - &id062
                      $ref: '#/components/schemas/ProjectRolePermission'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id062
                        - type: array
                          items: *id062
                required:
                - createprojectrolepermissionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createprojectrolepermissionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createprojectrolepermissionresponse
      x-cloudstack-command: createProjectRolePermission
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
      x-cloudstack-related:
      - listProjectRolePermissions
  /createRemoteAccessVpn:
    get:
      operationId: createRemoteAccessVpn
      summary: Creates a l2tp/ipsec remote access VPN
      description: |-
        Creates a l2tp/ipsec remote access VPN

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - RemoteAccessVpn
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createRemoteAccessVpn
          default: createRemoteAccessVpn
      - $ref: '#/components/parameters/response'
      - name: publicipid
        in: query
        description: Public IP address id of the VPN server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - updateIpAddress
      - name: account
        in: query
        description: An optional Account for the VPN. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the VPN. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the VPN to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: iprange
        in: query
        description: The range of IP addresses to allocate to VPN clients. The first IP in the range will be taken by the VPN server
        schema:
          type: string
          maxLength: 255
      - name: openfirewall
        in: query
        description: If true, firewall rule for source/end public port is automatically created; if false - firewall rule has to be created explicitly. Has value true by default
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `createRemoteAccessVpn`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createremoteaccessvpnresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createremoteaccessvpnresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createremoteaccessvpnresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createremoteaccessvpnresponse
      x-cloudstack-command: createRemoteAccessVpn
      x-cloudstack-async: true
      x-cloudstack-related:
      - listRemoteAccessVpns
      x-cloudstack-jobresult-schema: '#/components/schemas/RemoteAccessVpn'
  /createResourceSchedule:
    get:
      operationId: createResourceSchedule
      summary: Create Resource Schedule
      tags:
      - ResourceSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createResourceSchedule
          default: createResourceSchedule
      - $ref: '#/components/parameters/response'
      - name: action
        in: query
        description: Action to take on the resource.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourceid
        in: query
        description: ID of the resource for which schedule is to be defined
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      - name: schedule
        in: query
        description: Schedule for action on resource in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: Description of the schedule
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: Map of (key/value pairs) details for the schedule. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: enabled
        in: query
        description: Enable schedule. Defaults to true
        schema:
          type: boolean
      - name: enddate
        in: query
        description: End date after which the schedule becomes inactive. (Format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: startdate
        in: query
        description: Start date from which the schedule becomes active. Defaults to current date plus 1 minute. (Format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createResourceSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createresourcescheduleresponse:
                    oneOf:
                    - &id063
                      $ref: '#/components/schemas/ResourceSchedule'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id063
                        - type: array
                          items: *id063
                required:
                - createresourcescheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createresourcescheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createresourcescheduleresponse
      x-cloudstack-command: createResourceSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - listResourceSchedule
      - updateResourceSchedule
  /createRole:
    get:
      operationId: createRole
      summary: Creates a role
      tags:
      - Role
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createRole
          default: createRole
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Creates a role with this unique name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: The description of the role
        schema:
          type: string
          maxLength: 255
      - name: ispublic
        in: query
        description: Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.
        schema:
          type: boolean
      - name: roleid
        in: query
        description: ID of the role to be cloned from. Either roleid or type must be passed in
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - listRoles
        - updateRole
      - name: type
        in: query
        description: 'The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createroleresponse:
                    oneOf:
                    - &id064
                      $ref: '#/components/schemas/Role'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id064
                        - type: array
                          items: *id064
                required:
                - createroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createroleresponse
      x-cloudstack-command: createRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - listRoles
      - updateRole
  /createRolePermission:
    get:
      operationId: createRolePermission
      summary: Adds an API permission to a role
      tags:
      - RolePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createRolePermission
          default: createRolePermission
      - $ref: '#/components/parameters/response'
      - name: permission
        in: query
        description: 'The rule permission, allow or deny. Default: deny.'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: roleid
        in: query
        description: ID of the role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - importRole
        - listRoles
        - updateRole
      - name: rule
        in: query
        description: The API name or wildcard rule such as list*
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: The description of the role permission
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createRolePermission`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createrolepermissionresponse:
                    oneOf:
                    - &id065
                      $ref: '#/components/schemas/RolePermission'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id065
                        - type: array
                          items: *id065
                required:
                - createrolepermissionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createrolepermissionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createrolepermissionresponse
      x-cloudstack-command: createRolePermission
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - listRolePermissions
  /createRoutingFirewallRule:
    get:
      operationId: createRoutingFirewallRule
      summary: Creates a routing firewall rule in the given network in ROUTED mode
      description: |-
        Creates a routing firewall rule in the given network in ROUTED mode

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - RoutingFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createRoutingFirewallRule
          default: createRoutingFirewallRule
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: The network of the VM the firewall rule will be created for
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: protocol
        in: query
        description: the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number
        required: true
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: destcidrlist
        in: query
        description: the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: endport
        in: query
        description: the ending port of firewall rule
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: an optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
      - name: icmpcode
        in: query
        description: error code for this ICMP message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: type of the ICMP message being sent
        schema:
          type: integer
          format: int32
      - name: startport
        in: query
        description: the starting port of firewall rule
        schema:
          type: integer
          format: int32
      - name: traffictype
        in: query
        description: the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createRoutingFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createroutingfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createroutingfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createroutingfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createroutingfirewallruleresponse
      x-cloudstack-command: createRoutingFirewallRule
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createIpForwardingRule
      - createPortForwardingRule
      - listRoutingFirewallRules
      - updateIpv6FirewallRule
      - updatePortForwardingRule
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv6FirewallRule'
  /createSSHKeyPair:
    get:
      operationId: createSSHKeyPair
      summary: Create a new keypair and returns the private key
      tags:
      - SSHKeyPair
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createSSHKeyPair
          default: createSSHKeyPair
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the keypair
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: An optional Account for the SSH key. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the SSH key. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: projectid
        in: query
        description: An optional project for the SSH key
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `createSSHKeyPair`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsshkeypairresponse:
                    oneOf:
                    - &id066
                      $ref: '#/components/schemas/SSHKeyPair'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id066
                        - type: array
                          items: *id066
                required:
                - createsshkeypairresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsshkeypairresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createsshkeypairresponse
      x-cloudstack-command: createSSHKeyPair
      x-cloudstack-async: false
  /createSecondaryStagingStore:
    get:
      operationId: createSecondaryStagingStore
      summary: Create secondary staging store.
      tags:
      - SecondaryStagingStore
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createSecondaryStagingStore
          default: createSecondaryStagingStore
      - $ref: '#/components/parameters/response'
      - name: url
        in: query
        description: The URL for the staging store
        required: true
        schema:
          type: string
          maxLength: 2048
      - name: details
        in: query
        description: The details for the staging store. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: provider
        in: query
        description: The staging store provider name
        schema:
          type: string
          maxLength: 255
      - name: scope
        in: query
        description: 'The scope of the staging store: zone only for now'
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID for the staging store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createSecondaryStagingStore`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsecondarystagingstoreresponse:
                    oneOf:
                    - &id067
                      $ref: '#/components/schemas/ImageStore'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id067
                        - type: array
                          items: *id067
                required:
                - createsecondarystagingstoreresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsecondarystagingstoreresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createsecondarystagingstoreresponse
      x-cloudstack-command: createSecondaryStagingStore
      x-cloudstack-async: false
      x-cloudstack-related:
      - addImageStore
      - addImageStoreS3
      - addSecondaryStorage
      - addSwift
      - listImageStores
      - listSwifts
      - updateCloudToUseObjectStore
      - updateImageStore
  /createSecondaryStorageSelector:
    get:
      operationId: createSecondaryStorageSelector
      summary: Creates a secondary storage selector, described by the heuristic rule.
      tags:
      - SecondaryStorageSelector
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createSecondaryStorageSelector
          default: createSecondaryStorageSelector
      - $ref: '#/components/parameters/response'
      - name: description
        in: query
        description: The description of the heuristic rule.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: heuristicrule
        in: query
        description: The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.
        required: true
        schema:
          type: string
          maxLength: 65535
      - name: name
        in: query
        description: The name identifying the heuristic rule.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: 'The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, BACKUP, TEMPLATE and VOLUME.'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The zone in which the heuristic rule will be applied.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createSecondaryStorageSelector`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsecondarystorageselectorresponse:
                    oneOf:
                    - &id068
                      $ref: '#/components/schemas/SecondaryStorageSelector'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id068
                        - type: array
                          items: *id068
                required:
                - createsecondarystorageselectorresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsecondarystorageselectorresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createsecondarystorageselectorresponse
      x-cloudstack-command: createSecondaryStorageSelector
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - listSecondaryStorageSelectors
      - updateSecondaryStorageSelector
  /createSecurityGroup:
    get:
      operationId: createSecurityGroup
      summary: Creates a security group
      tags:
      - SecurityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createSecurityGroup
          default: createSecurityGroup
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the security group
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: An optional account for the security group. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: The description of the security group
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the security group. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: projectid
        in: query
        description: Create security group for project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      responses:
        '200':
          description: Successful invocation of `createSecurityGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsecuritygroupresponse:
                    oneOf:
                    - &id069
                      $ref: '#/components/schemas/SecurityGroup'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id069
                        - type: array
                          items: *id069
                required:
                - createsecuritygroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsecuritygroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createsecuritygroupresponse
      x-cloudstack-command: createSecurityGroup
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateSecurityGroup
  /createServiceInstance:
    get:
      operationId: createServiceInstance
      summary: Creates a system virtual-machine that implements network services
      description: |-
        Creates a system virtual-machine that implements network services

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ServiceInstance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createServiceInstance
          default: createServiceInstance
      - $ref: '#/components/parameters/response'
      - name: leftnetworkid
        in: query
        description: The left (inside) network for service instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: name
        in: query
        description: The name of the service instance
        required: true
        schema:
          type: string
          maxLength: 255
      - name: rightnetworkid
        in: query
        description: The right (outside) network ID for the service instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: serviceofferingid
        in: query
        description: The service offering ID that defines the resources consumed by the service appliance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: templateid
        in: query
        description: The template ID that specifies the image for the service appliance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: zoneid
        in: query
        description: Availability zone for the service instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: An optional account for the virtual machine. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: projectid
        in: query
        description: Project ID for the service instance
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createServiceInstance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createserviceinstanceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createserviceinstanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createserviceinstanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createserviceinstanceresponse
      x-cloudstack-command: createServiceInstance
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/ServiceInstance'
  /createServiceOffering:
    get:
      operationId: createServiceOffering
      summary: Creates a service offering.
      tags:
      - ServiceOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createServiceOffering
          default: createServiceOffering
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the service offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: bytesreadrate
        in: query
        description: Bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: bytesreadratemax
        in: query
        description: Burst bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: bytesreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: byteswriterate
        in: query
        description: Bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: byteswriteratemax
        in: query
        description: Burst bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: byteswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: cachemode
        in: query
        description: The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.14'
      - name: cpunumber
        in: query
        description: The CPU number of the service offering
        schema:
          type: integer
          format: int32
      - name: cpuspeed
        in: query
        description: |-
          For VMware and Xen based hypervisors this is the CPU speed of the service offering in MHz.
          For the KVM hypervisor, the values of the parameters cpuSpeed and cpuNumber will be used to calculate the `shares` value. This value is used by the KVM hypervisor to calculate how much time the Instance will have access to the host's CPU. The `shares` value does not have a unit, and its purpose is being a weight value for the host to compare between its guest Instances. For more information, see https://libvirt.org/formatdomain.html#cpu-tuning.
        schema:
          type: integer
          format: int32
      - name: customized
        in: query
        description: Whether service offering size is custom or not
        schema:
          type: boolean
        x-cloudstack-since: '4.13'
      - name: customizediops
        in: query
        description: Whether compute offering iops is custom or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: deploymentplanner
        in: query
        description: The deployment planner heuristics used to deploy an Instance of this offering. If null, value of global config vm.deployment.planner is used
        schema:
          type: string
          maxLength: 255
      - name: diskofferingid
        in: query
        description: The ID of the disk offering to which service offering should be mapped
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
      - name: diskofferingstrictness
        in: query
        description: True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when VM is deployed and change disk offering is not allowed for the ROOT disk after the VM is deployed
        schema:
          type: boolean
        x-cloudstack-since: '4.17'
      - name: displaytext
        in: query
        description: The display text of the service offering, defaults to 'name'.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listDomains
      - name: dynamicscalingenabled
        in: query
        description: True if Instance needs to be dynamically scalable of cpu or memory
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: encryptroot
        in: query
        description: VMs using this offering require root volume encryption
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: gpucount
        in: query
        description: Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.21'
      - name: gpudisplay
        in: query
        description: Whether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.
        schema:
          type: boolean
        x-cloudstack-since: '4.21'
      - name: hosttags
        in: query
        description: The host tag for this service offering.
        schema:
          type: string
          maxLength: 255
      - name: hypervisorsnapshotreserve
        in: query
        description: Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.4'
      - name: iopsreadrate
        in: query
        description: I/O requests read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopsreadratemax
        in: query
        description: Burst requests read rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopsreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: iopswriterate
        in: query
        description: I/O requests write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopswriteratemax
        in: query
        description: Burst io requests write rate of the disk offering
        schema:
          type: integer
          format: int64
      - name: iopswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
      - name: issystem
        in: query
        description: Is this a system vm offering
        schema:
          type: boolean
      - name: isvolatile
        in: query
        description: True if the Instance needs to be volatile so that on every reboot, the original root disk is detached, then destroyed and a fresh root disk is created and attached to the Instance
        schema:
          type: boolean
      - name: leaseduration
        in: query
        description: Number of days instance is leased for.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.21.0
      - name: leaseexpiryaction
        in: query
        description: Lease expiry action, valid values are STOP and DESTROY
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: limitcpuuse
        in: query
        description: Restrict the CPU usage to committed service offering
        schema:
          type: boolean
      - name: maxcpunumber
        in: query
        description: The maximum number of CPUs to be set with Custom Computer Offering
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.13'
      - name: maxiops
        in: query
        description: Max iops of the compute offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.4'
      - name: maxmemory
        in: query
        description: The maximum memory size of the custom service offering in MB
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.13'
      - name: memory
        in: query
        description: The total memory of the service offering in MB
        schema:
          type: integer
          format: int32
      - name: mincpunumber
        in: query
        description: The minimum number of CPUs to be set with Custom Computer Offering
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.13'
      - name: miniops
        in: query
        description: Min iops of the compute offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.4'
      - name: minmemory
        in: query
        description: The minimum memory size of the custom service offering in MB
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.13'
      - name: networkrate
        in: query
        description: Data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having "domainrouter" systemvmtype
        schema:
          type: integer
          format: int32
      - name: offerha
        in: query
        description: The HA for the service offering
        schema:
          type: boolean
      - name: provisioningtype
        in: query
        description: Provisioning type used to create volumes. Valid values are thin, sparse, fat.
        schema:
          type: string
          maxLength: 255
      - name: purgeresources
        in: query
        description: Whether to cleanup instance and its associated resource from database upon expunge of the instance
        schema:
          type: boolean
        x-cloudstack-since: '4.20'
      - name: rootdisksize
        in: query
        description: The Root disk size in GB.
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: serviceofferingdetails
        in: query
        description: Details for planner, used to store specific parameters. Map parameter. CloudStack expects it index-encoded as `serviceofferingdetails[0].key=k&serviceofferingdetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: storagepolicy
        in: query
        description: Name of the storage policy defined at vCenter, this is applicable only for VMware
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.15'
      - name: storagetype
        in: query
        description: The storage type of the service offering. Values are local and shared.
        schema:
          type: string
          maxLength: 255
      - name: systemvmtype
        in: query
        description: The system VM type. Possible types are "domainrouter", "consoleproxy" and "secondarystoragevm".
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: The tags for this service offering.
        schema:
          type: string
          maxLength: 255
      - name: vgpuprofileid
        in: query
        description: the ID of the vGPU profile to which service offering should be mapped
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.21'
      - name: zoneid
        in: query
        description: The ID of the containing zone(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createServiceOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createserviceofferingresponse:
                    oneOf:
                    - &id070
                      $ref: '#/components/schemas/ServiceOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id070
                        - type: array
                          items: *id070
                required:
                - createserviceofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createserviceofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createserviceofferingresponse
      x-cloudstack-command: createServiceOffering
      x-cloudstack-async: false
      x-cloudstack-related:
      - listServiceOfferings
      - updateServiceOffering
  /createSharedFileSystem:
    get:
      operationId: createSharedFileSystem
      summary: Create a new Shared File System of specified size and disk offering, attached to the given network
      description: |-
        Create a new Shared File System of specified size and disk offering, attached to the given network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createSharedFileSystem
          default: createSharedFileSystem
      - $ref: '#/components/parameters/response'
      - name: diskofferingid
        in: query
        description: the disk offering to use for the underlying storage. This will define the size and other specifications like encryption and qos for the shared filesystem.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
        - listDiskOfferings
      - name: filesystem
        in: query
        description: the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: the name of the shared filesystem.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: network to attach the shared filesystem to
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: serviceofferingid
        in: query
        description: the service offering to use for the shared filesystem instance hosting the data. The offering should be HA enabled and the cpu count and memory size should be greater than equal to sharedfsvm.min.cpu.count and sharedfsvm.min.ram.size respectively
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: zoneid
        in: query
        description: the zone id.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: account
        in: query
        description: the account associated with the shared filesystem. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: the description for the shared filesystem.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: the domain ID associated with the shared filesystem. If used with the account parameter returns the shared filesystem associated with the account for the specified domain.If account is NOT provided then the shared filesystem will be assigned to the caller account and domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: maxiops
        in: query
        description: max iops
        schema:
          type: integer
          format: int64
      - name: miniops
        in: query
        description: min iops
        schema:
          type: integer
          format: int64
      - name: projectid
        in: query
        description: the project associated with the shared filesystem. Mutually exclusive with account parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: provider
        in: query
        description: the provider to be used for the shared filesystem. The list of providers can be fetched by using the listSharedFileSystemProviders API.
        schema:
          type: string
          maxLength: 255
      - name: size
        in: query
        description: the size of the shared filesystem in GiB
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `createSharedFileSystem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsharedfilesystemresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createsharedfilesystemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsharedfilesystemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createsharedfilesystemresponse
      x-cloudstack-command: createSharedFileSystem
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - changeSharedFileSystemDiskOffering
      - changeSharedFileSystemServiceOffering
      - listSharedFileSystems
      - startSharedFileSystem
      - stopSharedFileSystem
      x-cloudstack-jobresult-schema: '#/components/schemas/SharedFileSystem'
  /createSnapshot:
    get:
      operationId: createSnapshot
      summary: Creates an instant Snapshot of a volume.
      description: |-
        Creates an instant Snapshot of a volume.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Snapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createSnapshot
          default: createSnapshot
      - $ref: '#/components/parameters/response'
      - name: volumeid
        in: query
        description: The ID of the disk volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: account
        in: query
        description: The Account of the Snapshot. The Account parameter must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: asyncbackup
        in: query
        description: Asynchronous backup if true
        schema:
          type: boolean
      - name: domainid
        in: query
        description: The domain ID of the Snapshot. If used with the Account parameter, specifies a domain for the Account associated with the disk volume. If Account is NOT provided then snapshot will be assigned to the caller Account and domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: locationtype
        in: query
        description: 'Currently applicable only for managed storage. Valid location types: ''primary'', ''secondary''. Default = ''primary''.'
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Snapshot
        schema:
          type: string
          maxLength: 255
      - name: policyid
        in: query
        description: Policy ID of the Snapshot, if this is null, then use MANUAL_POLICY.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listSnapshotPolicies
        - updateSnapshotPolicy
      - name: quiescevm
        in: query
        description: Quiesce Instance if true
        schema:
          type: boolean
      - name: storageids
        in: query
        description: A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: tags
        in: query
        description: Map of tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: usestoragereplication
        in: query
        description: Enables the snapshot to be copied to the supported primary storages when the config 'use.storage.replication' is set to true for the storage or globally. This is supported only for StorPool storage for now.
        schema:
          type: boolean
      - name: zoneids
        in: query
        description: A comma-separated list of IDs of the zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.19.0
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createsnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createsnapshotresponse
      x-cloudstack-command: createSnapshot
      x-cloudstack-async: true
      x-cloudstack-related:
      - archiveSnapshot
      - copySnapshot
      - createSnapshotFromVMSnapshot
      - listSnapshots
      - revertSnapshot
      x-cloudstack-jobresult-schema: '#/components/schemas/Snapshot'
  /createSnapshotFromVMSnapshot:
    get:
      operationId: createSnapshotFromVMSnapshot
      summary: Creates an instant Snapshot of a volume from existing Instance Snapshot.
      description: |-
        Creates an instant Snapshot of a volume from existing Instance Snapshot.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VMSnapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createSnapshotFromVMSnapshot
          default: createSnapshotFromVMSnapshot
      - $ref: '#/components/parameters/response'
      - name: vmsnapshotid
        in: query
        description: The ID of the Instance Snapshot
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVMSnapshot
        - listVMSnapshot
      - name: volumeid
        in: query
        description: The ID of the disk volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: name
        in: query
        description: The name of the Snapshot
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createSnapshotFromVMSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsnapshotfromvmsnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createsnapshotfromvmsnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsnapshotfromvmsnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createsnapshotfromvmsnapshotresponse
      x-cloudstack-command: createSnapshotFromVMSnapshot
      x-cloudstack-async: true
      x-cloudstack-since: 4.10.0
      x-cloudstack-related:
      - archiveSnapshot
      - copySnapshot
      - listSnapshots
      x-cloudstack-jobresult-schema: '#/components/schemas/Snapshot'
  /createSnapshotPolicy:
    get:
      operationId: createSnapshotPolicy
      summary: Creates a Snapshot policy for the account.
      tags:
      - SnapshotPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createSnapshotPolicy
          default: createSnapshotPolicy
      - $ref: '#/components/parameters/response'
      - name: intervaltype
        in: query
        description: Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY
        required: true
        schema:
          type: string
          maxLength: 255
      - name: maxsnaps
        in: query
        description: Maximum number of Snapshots to retain
        required: true
        schema:
          type: integer
          format: int32
      - name: schedule
        in: query
        description: Time the Snapshot is scheduled to be taken. Format is:* if HOURLY, MM* if DAILY, MM:HH* if WEEKLY, MM:HH:DD (1-7)* if MONTHLY, MM:HH:DD (1-28)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: volumeid
        in: query
        description: The ID of the disk volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the policy to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: storageids
        in: query
        description: A comma-separated list of IDs of the storage pools in other zones in which the snapshot will be made available. The snapshot will always be made available in the zone in which the volume is present. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: tags
        in: query
        description: Map of tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: usestoragereplication
        in: query
        description: Enables the snapshot to be copied to the supported primary storages when the config 'use.storage.replication' is set to true for the storage or globally. This is supported only for StorPool storage for now.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: zoneids
        in: query
        description: A list of IDs of the zones in which the snapshots will be made available.The snapshots will always be made available in the zone in which the volume is present. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createSnapshotPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsnapshotpolicyresponse:
                    oneOf:
                    - &id071
                      $ref: '#/components/schemas/SnapshotPolicy'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id071
                        - type: array
                          items: *id071
                required:
                - createsnapshotpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createsnapshotpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createsnapshotpolicyresponse
      x-cloudstack-command: createSnapshotPolicy
      x-cloudstack-async: false
      x-cloudstack-related:
      - listSnapshotPolicies
      - updateSnapshotPolicy
  /createStaticRoute:
    get:
      operationId: createStaticRoute
      summary: Creates a static route
      description: |-
        Creates a static route

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StaticRoute
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createStaticRoute
          default: createStaticRoute
      - $ref: '#/components/parameters/response'
      - name: cidr
        in: query
        description: Static route CIDR
        required: true
        schema:
          type: string
          maxLength: 255
      - name: gatewayid
        in: query
        description: The gateway ID we are creating static route for. Mutually exclusive with the nexthop parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPrivateGateway
        - listPrivateGateways
      - name: nexthop
        in: query
        description: the next hop of static route. Mutually exclusive with the gatewayid parameter
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: vpcid
        in: query
        description: the vpc id for which the static route is created. This is required for nexthop parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `createStaticRoute`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createstaticrouteresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createstaticrouteresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createstaticrouteresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createstaticrouteresponse
      x-cloudstack-command: createStaticRoute
      x-cloudstack-async: true
      x-cloudstack-related:
      - listStaticRoutes
      x-cloudstack-jobresult-schema: '#/components/schemas/StaticRoute'
  /createStorageNetworkIpRange:
    get:
      operationId: createStorageNetworkIpRange
      summary: Creates a Storage network IP range.
      description: |-
        Creates a Storage network IP range.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StorageNetworkIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createStorageNetworkIpRange
          default: createStorageNetworkIpRange
      - $ref: '#/components/parameters/response'
      - name: gateway
        in: query
        description: The gateway for storage network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The netmask for storage network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: ID of pod where the IP range belongs to
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: startip
        in: query
        description: The starting IP address
        required: true
        schema:
          type: string
          maxLength: 255
      - name: endip
        in: query
        description: The ending IP address
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: Optional. The VLAN the IP range sits on, default to Null when it is not specified which means your network is not on any VLAN. This is mainly for VMware as other hypervisors can directly retrieve bridge from physical network traffic type table
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `createStorageNetworkIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createstoragenetworkiprangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createstoragenetworkiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createstoragenetworkiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createstoragenetworkiprangeresponse
      x-cloudstack-command: createStorageNetworkIpRange
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/StorageNetworkIpRange'
  /createStoragePool:
    get:
      operationId: createStoragePool
      summary: Creates a storage pool.
      tags:
      - StoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createStoragePool
          default: createStoragePool
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name for the storage pool
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The URL of the storage pool
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID for the storage pool
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: capacitybytes
        in: query
        description: Bytes CloudStack can provision from this storage pool
        schema:
          type: integer
          format: int64
      - name: capacityiops
        in: query
        description: IOPS CloudStack can provision from this storage pool
        schema:
          type: integer
          format: int64
      - name: clusterid
        in: query
        description: The cluster ID for the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
      - name: details
        in: query
        description: The details for the storage pool. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: hypervisor
        in: query
        description: Hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.
        schema:
          type: string
          maxLength: 255
      - name: istagarule
        in: query
        description: Whether the informed tag is a JS interpretable rule or not.
        schema:
          type: boolean
      - name: managed
        in: query
        description: Whether the storage should be managed by CloudStack
        schema:
          type: boolean
      - name: podid
        in: query
        description: The Pod ID for the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: provider
        in: query
        description: The storage provider name
        schema:
          type: string
          maxLength: 255
      - name: scope
        in: query
        description: 'The scope of the storage: cluster or zone'
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroups
        in: query
        description: comma separated list of storage access groups for connecting to hosts having those specific groups
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: tags
        in: query
        description: The tags for the storage pool
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createStoragePool`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createstoragepoolresponse:
                    oneOf:
                    - &id072
                      $ref: '#/components/schemas/StoragePool'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id072
                        - type: array
                          items: *id072
                required:
                - createstoragepoolresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createstoragepoolresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createstoragepoolresponse
      x-cloudstack-command: createStoragePool
      x-cloudstack-async: false
      x-cloudstack-related:
      - cancelStorageMaintenance
      - enableStorageMaintenance
      - findStoragePoolsForMigration
  /createTags:
    get:
      operationId: createTags
      summary: Creates resource tag(s)
      description: |-
        Creates resource tag(s)

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Tag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTags
          default: createTags
      - $ref: '#/components/parameters/response'
      - name: resourceids
        in: query
        description: List of resources to create the tags for. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: Map of tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        required: true
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: customer
        in: query
        description: Identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createTags`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtagsresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtagsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtagsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtagsresponse
      x-cloudstack-command: createTags
      x-cloudstack-async: true
      x-cloudstack-since: 4.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /createTemplate:
    get:
      operationId: createTemplate
      summary: Creates a Template of an Instance.
      description: |-
        Creates a Template of an Instance. The Instance must be in a STOPPED state. A Template created from this command is automatically designated as a private Template visible to the account that created it.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTemplate
          default: createTemplate
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the Template
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ostypeid
        in: query
        description: The ID of the OS Type that best represents the OS of this Template.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
      - name: account
        in: query
        description: an optional accountName. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: arch
        in: query
        description: 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x. Defaults to x86_64'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.2
      - name: bits
        in: query
        description: 32 or 64 bit
        schema:
          type: integer
          format: int32
      - name: details
        in: query
        description: 'Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: displaytext
        in: query
        description: The display text of the Template, defaults to the 'name'.
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: an optional domainId. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.19.0
        x-cloudstack-related:
        - listDomains
      - name: isdynamicallyscalable
        in: query
        description: True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
        schema:
          type: boolean
      - name: isfeatured
        in: query
        description: True if this Template is a featured Template, false otherwise
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: True if this Template is a public Template, false otherwise
        schema:
          type: boolean
      - name: passwordenabled
        in: query
        description: True if the Template supports the password reset feature; default is false
        schema:
          type: boolean
      - name: projectid
        in: query
        description: Create Template for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: requireshvm
        in: query
        description: True if the Template requires HVM, false otherwise
        schema:
          type: boolean
      - name: snapshotid
        in: query
        description: The ID of the Snapshot the Template is being created from. Either this parameter, or volumeId has to be passed in
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copySnapshot
        - listSnapshots
      - name: sshkeyenabled
        in: query
        description: True if the Template supports the SSHkey upload feature; default is false
        schema:
          type: boolean
      - name: templatetag
        in: query
        description: The tag for this Template.
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: Optional, only for baremetal hypervisor. The directory name where Template stored on CIFS server
        schema:
          type: string
          maxLength: 2048
      - name: virtualmachineid
        in: query
        description: Optional, Instance ID. If this presents, it is going to create a baremetal Template for Instance this ID refers to. This is only for Instance whose hypervisor type is BareMetal
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: volumeid
        in: query
        description: The ID of the disk volume the Template is being created from. Either this parameter, or snapshotId has to be passed in
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: zoneid
        in: query
        description: the zone for the template. Can be specified with snapshot only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.19.0
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtemplateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtemplateresponse
      x-cloudstack-command: createTemplate
      x-cloudstack-async: true
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateVnfTemplate
      x-cloudstack-jobresult-schema: '#/components/schemas/Template'
  /createTungstenFabricAddressGroup:
    get:
      operationId: createTungstenFabricAddressGroup
      summary: Create Tungsten-Fabric address group
      description: |-
        Create Tungsten-Fabric address group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricAddressGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricAddressGroup
          default: createTungstenFabricAddressGroup
      - $ref: '#/components/parameters/response'
      - name: ipprefix
        in: query
        description: Tungsten-Fabric ip prefix
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ipprefixlen
        in: query
        description: Tungsten-Fabric ip prefix length
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: Tungsten-Fabric address group name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricAddressGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricaddressgroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabricaddressgroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricaddressgroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricaddressgroupresponse
      x-cloudstack-command: createTungstenFabricAddressGroup
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricAddressGroup'
  /createTungstenFabricApplicationPolicySet:
    get:
      operationId: createTungstenFabricApplicationPolicySet
      summary: Create Tungsten-Fabric application policy set
      description: |-
        Create Tungsten-Fabric application policy set

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricApplicationPolicySet
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricApplicationPolicySet
          default: createTungstenFabricApplicationPolicySet
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Tungsten-Fabric application policy set name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricApplicationPolicySet`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricapplicationpolicysetresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabricapplicationpolicysetresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricapplicationpolicysetresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricapplicationpolicysetresponse
      x-cloudstack-command: createTungstenFabricApplicationPolicySet
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricApplicationPolicySet'
  /createTungstenFabricFirewallPolicy:
    get:
      operationId: createTungstenFabricFirewallPolicy
      summary: Create Tungsten-Fabric firewall policy
      description: |-
        Create Tungsten-Fabric firewall policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricFirewallPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricFirewallPolicy
          default: createTungstenFabricFirewallPolicy
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Tungsten-Fabric firewall policy name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: sequence
        in: query
        description: The sequence of Tungsten-Fabric firewall policy
        required: true
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: applicationpolicysetuuid
        in: query
        description: The UUID of Tungsten-Fabric application policy set
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricFirewallPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricfirewallpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabricfirewallpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricfirewallpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricfirewallpolicyresponse
      x-cloudstack-command: createTungstenFabricFirewallPolicy
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricFirewallPolicy'
  /createTungstenFabricFirewallRule:
    get:
      operationId: createTungstenFabricFirewallRule
      summary: Create Tungsten-Fabric firewall
      description: |-
        Create Tungsten-Fabric firewall

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricFirewallRule
          default: createTungstenFabricFirewallRule
      - $ref: '#/components/parameters/response'
      - name: action
        in: query
        description: Tungsten-Fabric firewall rule action
        required: true
        schema:
          type: string
          maxLength: 255
      - name: direction
        in: query
        description: Tungsten-Fabric firewall rule direction
        required: true
        schema:
          type: string
          maxLength: 255
      - name: firewallpolicyuuid
        in: query
        description: The UUID of Tungsten-Fabric firewall policy
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Tungsten-Fabric firewall rule name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: sequence
        in: query
        description: The sequence of Tungsten-Fabric firewall rule
        required: true
        schema:
          type: integer
          format: int32
      - name: servicegroupuuid
        in: query
        description: Tungsten-Fabric firewall rule service group uuid
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: destaddressgroupuuid
        in: query
        description: Tungsten-Fabric firewall rule destination address group uuid
        schema:
          type: string
          maxLength: 255
      - name: destnetworkuuid
        in: query
        description: The uuid of Tungsten-Fabric destination network
        schema:
          type: string
          maxLength: 255
      - name: desttaguuid
        in: query
        description: Tungsten-Fabric firewall rule destination tag uuid
        schema:
          type: string
          maxLength: 255
      - name: srcaddressgroupuuid
        in: query
        description: Tungsten-Fabric firewall rule source address group uuid
        schema:
          type: string
          maxLength: 255
      - name: srcnetworkuuid
        in: query
        description: The UUID of Tungsten-Fabric source network
        schema:
          type: string
          maxLength: 255
      - name: srctaguuid
        in: query
        description: Tungsten-Fabric firewall rule source tag uuid
        schema:
          type: string
          maxLength: 255
      - name: tagtypeuuid
        in: query
        description: Tungsten-Fabric firewall rule tag type uuid
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabricfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricfirewallruleresponse
      x-cloudstack-command: createTungstenFabricFirewallRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - listTungstenFabricFirewallRule
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricFirewallRule'
  /createTungstenFabricLogicalRouter:
    get:
      operationId: createTungstenFabricLogicalRouter
      summary: Create Tungsten-Fabric logical router
      description: |-
        Create Tungsten-Fabric logical router

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricLogicalRouter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricLogicalRouter
          default: createTungstenFabricLogicalRouter
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Tungsten-Fabric logical router name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricLogicalRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabriclogicalrouterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabriclogicalrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabriclogicalrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabriclogicalrouterresponse
      x-cloudstack-command: createTungstenFabricLogicalRouter
      x-cloudstack-async: true
      x-cloudstack-related:
      - removeTungstenFabricNetworkGatewayFromLogicalRouter
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricPolicy'
  /createTungstenFabricManagementNetwork:
    get:
      operationId: createTungstenFabricManagementNetwork
      summary: Create Tungsten-Fabric management network
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricManagementNetwork
          default: createTungstenFabricManagementNetwork
      - $ref: '#/components/parameters/response'
      - name: podid
        in: query
        description: The ID of pod
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricManagementNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricmanagementnetworkresponse:
                    oneOf:
                    - &id073
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id073
                        - type: array
                          items: *id073
                required:
                - createtungstenfabricmanagementnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricmanagementnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricmanagementnetworkresponse
      x-cloudstack-command: createTungstenFabricManagementNetwork
      x-cloudstack-async: false
  /createTungstenFabricPolicy:
    get:
      operationId: createTungstenFabricPolicy
      summary: Create Tungsten-Fabric policy
      description: |-
        Create Tungsten-Fabric policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricPolicy
          default: createTungstenFabricPolicy
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Tungsten-Fabric policy name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabricpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricpolicyresponse
      x-cloudstack-command: createTungstenFabricPolicy
      x-cloudstack-async: true
      x-cloudstack-related:
      - listTungstenFabricPolicy
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricPolicy'
  /createTungstenFabricProvider:
    get:
      operationId: createTungstenFabricProvider
      summary: Create Tungsten-Fabric provider in cloudstack
      tags:
      - TungstenFabricProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricProvider
          default: createTungstenFabricProvider
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Tungsten-Fabric provider name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: tungstengateway
        in: query
        description: Tungsten-Fabric provider gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: tungstenproviderhostname
        in: query
        description: Tungsten-Fabric provider hostname
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: tungstenproviderintrospectport
        in: query
        description: Tungsten-Fabric provider introspect port
        schema:
          type: string
          maxLength: 255
      - name: tungstenproviderport
        in: query
        description: Tungsten-Fabric provider port
        schema:
          type: string
          maxLength: 255
      - name: tungstenprovidervrouterport
        in: query
        description: Tungsten-Fabric provider vrouter port
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricProvider`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricproviderresponse:
                    oneOf:
                    - &id074
                      $ref: '#/components/schemas/TungstenFabricProvider'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id074
                        - type: array
                          items: *id074
                required:
                - createtungstenfabricproviderresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricproviderresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricproviderresponse
      x-cloudstack-command: createTungstenFabricProvider
      x-cloudstack-async: false
  /createTungstenFabricPublicNetwork:
    get:
      operationId: createTungstenFabricPublicNetwork
      summary: Create Tungsten-Fabric public network
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricPublicNetwork
          default: createTungstenFabricPublicNetwork
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricPublicNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricpublicnetworkresponse:
                    oneOf:
                    - &id075
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id075
                        - type: array
                          items: *id075
                required:
                - createtungstenfabricpublicnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricpublicnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricpublicnetworkresponse
      x-cloudstack-command: createTungstenFabricPublicNetwork
      x-cloudstack-async: false
  /createTungstenFabricServiceGroup:
    get:
      operationId: createTungstenFabricServiceGroup
      summary: Create Tungsten-Fabric service group
      description: |-
        Create Tungsten-Fabric service group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricServiceGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricServiceGroup
          default: createTungstenFabricServiceGroup
      - $ref: '#/components/parameters/response'
      - name: endport
        in: query
        description: Tungsten-Fabric service group end port
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: Tungsten-Fabric service group name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: protocol
        in: query
        description: Tungsten-Fabric service group protocol
        required: true
        schema:
          type: string
          maxLength: 255
      - name: startport
        in: query
        description: Tungsten-Fabric service group start port
        required: true
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricServiceGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricservicegroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabricservicegroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabricservicegroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabricservicegroupresponse
      x-cloudstack-command: createTungstenFabricServiceGroup
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricServiceGroup'
  /createTungstenFabricTag:
    get:
      operationId: createTungstenFabricTag
      summary: Create Tungsten-Fabric tag
      description: |-
        Create Tungsten-Fabric tag

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricTag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricTag
          default: createTungstenFabricTag
      - $ref: '#/components/parameters/response'
      - name: tagtype
        in: query
        description: Tungsten-Fabric tag type
        required: true
        schema:
          type: string
          maxLength: 255
      - name: tagvalue
        in: query
        description: Tungsten-Fabric tag value
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricTag`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabrictagresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabrictagresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabrictagresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabrictagresponse
      x-cloudstack-command: createTungstenFabricTag
      x-cloudstack-async: true
      x-cloudstack-related:
      - applyTungstenFabricTag
      - listTungstenFabricTag
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricTag'
  /createTungstenFabricTagType:
    get:
      operationId: createTungstenFabricTagType
      summary: Create Tungsten-Fabric tag type
      description: |-
        Create Tungsten-Fabric tag type

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricTagType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createTungstenFabricTagType
          default: createTungstenFabricTagType
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Tungsten-Fabric tag type name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createTungstenFabricTagType`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabrictagtyperesponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createtungstenfabrictagtyperesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createtungstenfabrictagtyperesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createtungstenfabrictagtyperesponse
      x-cloudstack-command: createTungstenFabricTagType
      x-cloudstack-async: true
      x-cloudstack-related:
      - listTungstenFabricTagType
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricTagType'
  /createUser:
    get:
      operationId: createUser
      summary: Creates a user for an account that already exists
      tags:
      - User
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createUser
          default: createUser
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Creates the user under the specified account. If no account is specified, the username will be used as the account name.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: email
        in: query
        description: Email
        required: true
        schema:
          type: string
          maxLength: 255
      - name: firstname
        in: query
        description: Firstname
        required: true
        schema:
          type: string
          maxLength: 255
      - name: lastname
        in: query
        description: Lastname
        required: true
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: Clear text password (Default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Unique username.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Creates the user under the specified domain. Has to be accompanied with the account parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: passwordchangerequired
        in: query
        description: Provide true to mandate the User to reset password on next login.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
        schema:
          type: string
          maxLength: 255
      - name: userid
        in: query
        description: User UUID, required for adding account from external provisioning system
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createuserresponse:
                    oneOf:
                    - &id076
                      $ref: '#/components/schemas/User2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id076
                        - type: array
                          items: *id076
                required:
                - createuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createuserresponse
      x-cloudstack-command: createUser
      x-cloudstack-async: false
      x-cloudstack-related:
      - disableUser
      - getUser
      - listUsers
      - lockUser
  /createVMFromBackup:
    get:
      operationId: createVMFromBackup
      summary: Creates and automatically starts a VM from a backup.
      description: |-
        Creates and automatically starts a VM from a backup.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Backup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVMFromBackup
          default: createVMFromBackup
      - $ref: '#/components/parameters/response'
      - name: backupid
        in: query
        description: backup ID to create the VM from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: zoneid
        in: query
        description: availability zone for the virtual machine
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: an optional account for the virtual machine. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: affinitygroupids
        in: query
        description: comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createAffinityGroup
        - listAffinityGroups
      - name: affinitygroupnames
        in: query
        description: comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createAffinityGroup
        - listAffinityGroups
      - name: bootintosetup
        in: query
        description: Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)
        schema:
          type: boolean
        x-cloudstack-since: 4.15.0.0
      - name: bootmode
        in: query
        description: Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.14.0.0
      - name: boottype
        in: query
        description: Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.14.0.0
      - name: clusterid
        in: query
        description: destination Cluster ID to deploy the VM to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.21'
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: copyimagetags
        in: query
        description: if true the image tags (if any) will be copied to the VM, default value is false
        schema:
          type: boolean
        x-cloudstack-since: '4.13'
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
      - name: datadiskofferinglist
        in: query
        description: datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter. Map parameter. CloudStack expects it index-encoded as `datadiskofferinglist[0].key=k&datadiskofferinglist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.11'
      - name: datadisksdetails
        in: query
        description: 'Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>. Map parameter. CloudStack expects it index-encoded as `datadisksdetails[0].key=k&datadisksdetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: deploymentplanner
        in: query
        description: Deployment planner to use for vm allocation. Available to ROOT admin only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: details
        in: query
        description: used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.3'
      - name: dhcpoptionsnetworklist
        in: query
        description: 'DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com. Map parameter. CloudStack expects it index-encoded as `dhcpoptionsnetworklist[0].key=k&dhcpoptionsnetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: diskofferingid
        in: query
        description: the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: displayname
        in: query
        description: an optional user generated name for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: displayvm
        in: query
        description: an optional field, whether to the display the vm to the end user or not.
        schema:
          type: boolean
        x-cloudstack-since: '4.2'
      - name: domainid
        in: query
        description: an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: dynamicscalingenabled
        in: query
        description: true if virtual machine needs to be dynamically scalable
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: extraconfig
        in: query
        description: an optional URL encoded string that can be passed to the virtual machine upon successful deployment
        schema:
          type: string
          maxLength: 5120
        x-cloudstack-since: '4.12'
      - name: group
        in: query
        description: an optional group for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: hostid
        in: query
        description: destination Host ID to deploy the VM to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: hypervisor
        in: query
        description: the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call
        schema:
          type: string
          maxLength: 255
      - name: iodriverpolicy
        in: query
        description: Controls specific policies on IO
        schema:
          type: string
          maxLength: 255
      - name: iothreadsenabled
        in: query
        description: IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.
        schema:
          type: boolean
      - name: ip6address
        in: query
        description: the ipv6 address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: ipaddress
        in: query
        description: the ip address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: iptonetworklist
        in: query
        description: 'ip to network mapping. Can''t be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid. Map parameter. CloudStack expects it index-encoded as `iptonetworklist[0].key=k&iptonetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: keyboard
        in: query
        description: an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us
        schema:
          type: string
          maxLength: 255
      - name: keypair
        in: query
        description: name of the ssh key pair used to login to the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: keypairs
        in: query
        description: names of the ssh key pairs used to login to the virtual machine. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.17'
      - name: leaseduration
        in: query
        description: Number of days instance is leased for.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.21.0
      - name: leaseexpiryaction
        in: query
        description: Lease expiry action, valid values are STOP and DESTROY
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: macaddress
        in: query
        description: the mac address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: host name for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: networkids
        in: query
        description: list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: nicmultiqueuenumber
        in: query
        description: The number of queues for multiqueue NICs.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.18'
      - name: nicnetworklist
        in: query
        description: 'VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid. Map parameter. CloudStack expects it index-encoded as `nicnetworklist[0].key=k&nicnetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.15'
      - name: nicpackedvirtqueuesenabled
        in: query
        description: Enable packed virtqueues or not.
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: overridediskofferingid
        in: query
        description: the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
      - name: password
        in: query
        description: The password of the virtual machine. If null, a random password will be generated for the VM.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0.0
      - name: podid
        in: query
        description: destination Pod ID to deploy the VM to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.21'
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
      - name: preserveip
        in: query
        description: Use the same IP/MAC addresses as stored in the backup metadata. Works only if the original Instance is deleted and the IP/MAC address is available.
        schema:
          type: boolean
      - name: projectid
        in: query
        description: Deploy vm for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: properties
        in: query
        description: used to specify the vApp properties. Map parameter. CloudStack expects it index-encoded as `properties[0].key=k&properties[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.15'
      - name: quickrestore
        in: query
        description: Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: rootdiskkmskeyid
        in: query
        description: ID of the KMS Key to use for root disk encryption
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createKMSKey
        - updateKMSKey
      - name: rootdisksize
        in: query
        description: Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.4'
      - name: securitygroupids
        in: query
        description: comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - updateSecurityGroup
      - name: securitygroupnames
        in: query
        description: comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - updateSecurityGroup
      - name: serviceofferingid
        in: query
        description: the ID of the service offering for the virtual machine
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: size
        in: query
        description: the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId
        schema:
          type: integer
          format: int64
      - name: startvm
        in: query
        description: true if start vm after creating; defaulted to true if not specified
        schema:
          type: boolean
      - name: templateid
        in: query
        description: the ID of the template for the virtual machine
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: userdata
        in: query
        description: an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value
        schema:
          type: string
          maxLength: 1048576
      - name: userdatadetails
        in: query
        description: used to specify the parameters values for the variables in userdata. Map parameter. CloudStack expects it index-encoded as `userdatadetails[0].key=k&userdatadetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.18'
      - name: userdataid
        in: query
        description: the ID of the Userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.18'
        x-cloudstack-related:
        - listCniConfiguration
      responses:
        '200':
          description: Successful invocation of `createVMFromBackup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvmfrombackupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvmfrombackupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvmfrombackupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvmfrombackupresponse
      x-cloudstack-command: createVMFromBackup
      x-cloudstack-async: true
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /createVMSchedule:
    get:
      operationId: createVMSchedule
      summary: Create Instance Schedule
      tags:
      - VMSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVMSchedule
          default: createVMSchedule
      - $ref: '#/components/parameters/response'
      - name: action
        in: query
        description: Action to take on the Instance (start/stop/reboot/force_stop/force_reboot).
        required: true
        schema:
          type: string
          maxLength: 255
      - name: schedule
        in: query
        description: Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: ID of the Instance for which schedule is to be defined
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: description
        in: query
        description: Description of the schedule
        schema:
          type: string
          maxLength: 255
      - name: enabled
        in: query
        description: Enable Instance schedule. Defaults to true
        schema:
          type: boolean
      - name: enddate
        in: query
        description: End date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: startdate
        in: query
        description: Start date from which the schedule becomes active. Defaults to current date plus 1 minute.(Format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createVMSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvmscheduleresponse:
                    oneOf:
                    - &id077
                      $ref: '#/components/schemas/VMSchedule'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id077
                        - type: array
                          items: *id077
                required:
                - createvmscheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvmscheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvmscheduleresponse
      x-cloudstack-command: createVMSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - updateVMSchedule
  /createVMSnapshot:
    get:
      operationId: createVMSnapshot
      summary: Creates Snapshot for an Instance.
      description: |-
        Creates Snapshot for an Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VMSnapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVMSnapshot
          default: createVMSnapshot
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: description
        in: query
        description: The description of the Snapshot
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The display name of the Snapshot
        schema:
          type: string
          maxLength: 255
      - name: quiescevm
        in: query
        description: Quiesce Instance if true
        schema:
          type: boolean
      - name: snapshotmemory
        in: query
        description: Snapshot memory if true
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `createVMSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvmsnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvmsnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvmsnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvmsnapshotresponse
      x-cloudstack-command: createVMSnapshot
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-jobresult-schema: '#/components/schemas/VMSnapshot'
  /createVPC:
    get:
      operationId: createVPC
      summary: Creates a VPC
      description: |-
        Creates a VPC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPC
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVPC
          default: createVPC
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the VPC
        required: true
        schema:
          type: string
          maxLength: 255
      - name: vpcofferingid
        in: query
        description: The ID of the VPC offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneVPCOffering
        - listVPCOfferings
        - updateVPCOffering
      - name: zoneid
        in: query
        description: The ID of the availability zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: account
        in: query
        description: The Account associated with the VPC. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: asnumber
        in: query
        description: the AS Number of the VPC tiers
        schema:
          type: integer
          format: int64
        x-cloudstack-since: 4.20.0
      - name: bgppeerids
        in: query
        description: Ids of the Bgp Peer for the VPC. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.20.0
        x-cloudstack-related:
        - createBgpPeer
        - dedicateBgpPeer
        - listBgpPeers
        - releaseBgpPeer
        - updateBgpPeer
      - name: cidr
        in: query
        description: The CIDR of the VPC. All VPC Guest Network's CIDRs should be within this CIDR
        schema:
          type: string
          maxLength: 255
      - name: cidrsize
        in: query
        description: the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.20.0
      - name: displaytext
        in: query
        description: The display text of the VPC, defaults to its 'name'.
        schema:
          type: string
          maxLength: 255
      - name: dns1
        in: query
        description: The first IPv4 DNS for the VPC
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: dns2
        in: query
        description: The second IPv4 DNS for the VPC
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: domainid
        in: query
        description: The domain ID associated with the VPC. If used with the Account parameter returns the VPC associated with the Account for the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the VPC to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: ip6dns1
        in: query
        description: The first IPv6 DNS for the VPC
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: ip6dns2
        in: query
        description: The second IPv6 DNS for the VPC
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: keepmacaddressonpublicnic
        in: query
        description: Indicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have  a new MAC address.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: networkdomain
        in: query
        description: VPC Network domain. All Networks inside the VPC will belong to this domain
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: Create VPC for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: publicmtu
        in: query
        description: MTU to be configured on the Network VR's public facing interfaces
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.18.0
      - name: sourcenatipaddress
        in: query
        description: "IPv4 address to be assigned to the public interface of the Network router.This address will be used as source NAT address for the Networks in ths VPC. \nIf an address is given and it cannot be acquired, an error will be returned and the Network won´t be implemented,"
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.19'
      - name: start
        in: query
        description: If set to false, the VPC won't start (VPC VR will not get allocated) until its first Network gets implemented. True by default.
        schema:
          type: boolean
        x-cloudstack-since: '4.3'
      - name: userouteripresolver
        in: query
        description: '(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2'
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `createVPC`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpcresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvpcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvpcresponse
      x-cloudstack-command: createVPC
      x-cloudstack-async: true
      x-cloudstack-related:
      - createVPC
      - listVPCs
      - migrateVPC
      - updateVPC
      x-cloudstack-jobresult-schema: '#/components/schemas/VPC'
  /createVPCOffering:
    get:
      operationId: createVPCOffering
      summary: Creates VPC offering
      description: |-
        Creates VPC offering

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPCOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVPCOffering
          default: createVPCOffering
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the VPC offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: conservemode
        in: query
        description: True if the VPC offering is IP conserve mode enabled, allowing public IPs to be used across multiple VPC tiers. Default value is false
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: displaytext
        in: query
        description: The display text of the VPC offering, defaults to the 'name'
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: enable
        in: query
        description: Set to true if the offering is to be enabled during creation. Default is false
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: fornsx
        in: query
        description: true if network offering is meant to be used for NSX, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: internetprotocol
        in: query
        description: The internet protocol of the offering. Options are IPv4 and dualstack. Default is IPv4. dualstack will create an offering that supports both IPv4 and IPv6
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.17.0
      - name: networkmode
        in: query
        description: 'Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: nsxsupportlb
        in: query
        description: true if network offering for NSX VPC offering supports Load balancer service.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: provider
        in: query
        description: Name of the provider providing the service
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: routingmode
        in: query
        description: 'the routing mode for the VPC offering. Supported types are: Static or Dynamic.'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: servicecapabilitylist
        in: query
        description: Desired service capabilities as part of VPC offering. Map parameter. CloudStack expects it index-encoded as `servicecapabilitylist[0].key=k&servicecapabilitylist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.4'
      - name: serviceofferingid
        in: query
        description: The ID of the service offering for the VPC router appliance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneServiceOffering
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: serviceproviderlist
        in: query
        description: Provider to service mapping. If not specified, the provider for the service will be mapped to the default provider on the physical network. Map parameter. CloudStack expects it index-encoded as `serviceproviderlist[0].key=k&serviceproviderlist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: specifyasnumber
        in: query
        description: true if the VPC offering supports choosing AS number
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: supportedservices
        in: query
        description: Services supported by the VPC offering. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: zoneid
        in: query
        description: The ID of the containing zone(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `createVPCOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpcofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvpcofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpcofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvpcofferingresponse
      x-cloudstack-command: createVPCOffering
      x-cloudstack-async: true
      x-cloudstack-related:
      - cloneVPCOffering
      - listVPCOfferings
      - updateVPCOffering
      x-cloudstack-jobresult-schema: '#/components/schemas/VPCOffering'
  /createVgpuProfile:
    get:
      operationId: createVgpuProfile
      summary: Creates a vGPU profile in the system
      tags:
      - VgpuProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVgpuProfile
          default: createVgpuProfile
      - $ref: '#/components/parameters/response'
      - name: gpucardid
        in: query
        description: the GPU card ID associated with this GPU device
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: name
        in: query
        description: the name of the vGPU profile
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: the description of the vGPU profile
        schema:
          type: string
          maxLength: 255
      - name: maxheads
        in: query
        description: the maximum number of display heads
        schema:
          type: integer
          format: int64
      - name: maxresolutionx
        in: query
        description: the maximum X resolution
        schema:
          type: integer
          format: int64
      - name: maxresolutiony
        in: query
        description: the maximum Y resolution
        schema:
          type: integer
          format: int64
      - name: maxvgpuperphysicalgpu
        in: query
        description: Max vGPU per physical GPU. This is used to calculate capacity.
        schema:
          type: integer
          format: int64
      - name: videoram
        in: query
        description: the video RAM size in MB
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `createVgpuProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvgpuprofileresponse:
                    oneOf:
                    - &id078
                      $ref: '#/components/schemas/VgpuProfile'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id078
                        - type: array
                          items: *id078
                required:
                - createvgpuprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvgpuprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvgpuprofileresponse
      x-cloudstack-command: createVgpuProfile
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /createVirtualRouterElement:
    get:
      operationId: createVirtualRouterElement
      summary: Create a virtual router element.
      description: |-
        Create a virtual router element.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualRouterElement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVirtualRouterElement
          default: createVirtualRouterElement
      - $ref: '#/components/parameters/response'
      - name: nspid
        in: query
        description: The network service provider ID of the virtual router element
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetworkServiceProvider
        - listNetworkServiceProviders
      - name: providertype
        in: query
        description: The provider type. Supported types are VirtualRouter (default) and VPCVirtualRouter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetworkServiceProvider
        - listNetworkServiceProviders
      responses:
        '200':
          description: Successful invocation of `createVirtualRouterElement`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvirtualrouterelementresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvirtualrouterelementresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvirtualrouterelementresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvirtualrouterelementresponse
      x-cloudstack-command: createVirtualRouterElement
      x-cloudstack-async: true
      x-cloudstack-related:
      - configureVirtualRouterElement
      - listVirtualRouterElements
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualRouterElement'
  /createVlanIpRange:
    get:
      operationId: createVlanIpRange
      summary: Creates a VLAN IP range.
      tags:
      - VlanIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVlanIpRange
          default: createVlanIpRange
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Account who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Domain ID of the Account owning a VLAN
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: endip
        in: query
        description: The ending IP address in the VLAN IP range
        schema:
          type: string
          maxLength: 255
      - name: endipv6
        in: query
        description: The ending IPv6 address in the IPv6 network range
        schema:
          type: string
          maxLength: 255
      - name: forsystemvms
        in: query
        description: True if IP range is set to System VMs, false if not
        schema:
          type: boolean
      - name: forvirtualnetwork
        in: query
        description: True if VLAN is of Virtual type, false if Direct
        schema:
          type: boolean
      - name: gateway
        in: query
        description: The gateway of the VLAN IP range
        schema:
          type: string
          maxLength: 255
      - name: ip6cidr
        in: query
        description: The CIDR of IPv6 network, must be at least /64
        schema:
          type: string
          maxLength: 255
      - name: ip6gateway
        in: query
        description: The gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The netmask of the VLAN IP range
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: The Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: physicalnetworkid
        in: query
        description: The physical network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: podid
        in: query
        description: Optional parameter. Have to be specified for Direct Untagged vlan only.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: projectid
        in: query
        description: Project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: provider
        in: query
        description: Provider name for which the IP range is reserved for
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: startip
        in: query
        description: The beginning IP address in the VLAN IP range
        schema:
          type: string
          maxLength: 255
      - name: startipv6
        in: query
        description: The beginning IPv6 address in the IPv6 network range
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: The ID or VID of the VLAN. If not specified, will be defaulted to the vlan of the network or if vlan of the network is null - to Untagged
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID of the VLAN IP range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createVlanIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvlaniprangeresponse:
                    oneOf:
                    - &id079
                      $ref: '#/components/schemas/VlanIpRange'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id079
                        - type: array
                          items: *id079
                required:
                - createvlaniprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvlaniprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvlaniprangeresponse
      x-cloudstack-command: createVlanIpRange
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateVlanIpRange
  /createVolume:
    get:
      operationId: createVolume
      summary: Creates a disk volume from a disk offering.
      description: |-
        Creates a disk volume from a disk offering. This disk volume must still be attached to  an Instance to make use of it.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVolume
          default: createVolume
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The Account associated with the disk volume. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
      - name: diskofferingid
        in: query
        description: The ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: displayvolume
        in: query
        description: An optional field, whether to display the volume to the end User or not.
        schema:
          type: boolean
      - name: domainid
        in: query
        description: The domain ID associated with the disk offering. If used with the Account parameter returns the disk volume associated with the Account for the specified domain.If account is NOT provided then the volume will be assigned to the caller Account and domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: kmskeyid
        in: query
        description: ID of the KMS Key for volume encryption (required if encryption enabled for zone)
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - updateKMSKey
      - name: maxiops
        in: query
        description: Max IOPS
        schema:
          type: integer
          format: int64
      - name: miniops
        in: query
        description: Min IOPS
        schema:
          type: integer
          format: int64
      - name: name
        in: query
        description: The name of the disk volume
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: The project associated with the volume. Mutually exclusive with Account parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: size
        in: query
        description: Arbitrary volume size
        schema:
          type: integer
          format: int64
      - name: snapshotid
        in: query
        description: The Snapshot ID for the disk volume. Either diskOfferingId or snapshotId must be passed in.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listSnapshots
      - name: storageid
        in: query
        description: Storage pool ID to create the volume in. Cannot be used with the snapshotid parameter.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.22.1
        x-cloudstack-related:
        - cancelStorageMaintenance
        - enableStorageMaintenance
      - name: virtualmachineid
        in: query
        description: The ID of the Instance; to be used with snapshot Id, Instance to which the volume gets attached after creation
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: zoneid
        in: query
        description: The ID of the availability zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `createVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvolumeresponse
      x-cloudstack-command: createVolume
      x-cloudstack-async: true
      x-cloudstack-related:
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /createVpnConnection:
    get:
      operationId: createVpnConnection
      summary: Create site to site VPN connection
      description: |-
        Create site to site VPN connection

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnConnection
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVpnConnection
          default: createVpnConnection
      - $ref: '#/components/parameters/response'
      - name: s2scustomergatewayid
        in: query
        description: ID of the customer gateway
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVpnCustomerGateway
        - updateVpnCustomerGateway
      - name: s2svpngatewayid
        in: query
        description: ID of the VPN gateway
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVpnGateway
        - updateVpnGateway
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the VPN to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: passive
        in: query
        description: Connection is passive or not
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `createVpnConnection`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpnconnectionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvpnconnectionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpnconnectionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvpnconnectionresponse
      x-cloudstack-command: createVpnConnection
      x-cloudstack-async: true
      x-cloudstack-related:
      - updateVpnConnection
      x-cloudstack-jobresult-schema: '#/components/schemas/VpnConnection'
  /createVpnCustomerGateway:
    get:
      operationId: createVpnCustomerGateway
      summary: Creates site to site VPN customer gateway
      description: |-
        Creates site to site VPN customer gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnCustomerGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVpnCustomerGateway
          default: createVpnCustomerGateway
      - $ref: '#/components/parameters/response'
      - name: cidrlist
        in: query
        description: Guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).
        required: true
        schema:
          type: string
          maxLength: 255
      - name: esppolicy
        in: query
        description: ESP policy of the customer gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: gateway
        in: query
        description: Public IP address id of the customer gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ikepolicy
        in: query
        description: IKE policy of the customer gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ipsecpsk
        in: query
        description: IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: The Account associated with the gateway. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the Account for the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: dpd
        in: query
        description: If DPD is enabled for VPN connection
        schema:
          type: boolean
      - name: esplifetime
        in: query
        description: Lifetime of phase 2 VPN connection to the customer gateway, in seconds
        schema:
          type: integer
          format: int64
      - name: forceencap
        in: query
        description: Force Encapsulation for NAT traversal
        schema:
          type: boolean
      - name: ikelifetime
        in: query
        description: Lifetime of phase 1 VPN connection to the customer gateway, in seconds
        schema:
          type: integer
          format: int64
      - name: ikeversion
        in: query
        description: Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.15.1
      - name: name
        in: query
        description: Name of this customer gateway
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: Create site-to-site VPN customer gateway for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.6'
        x-cloudstack-related:
        - createProject
      - name: splitconnections
        in: query
        description: For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.
        schema:
          type: boolean
        x-cloudstack-since: 4.15.1
      responses:
        '200':
          description: Successful invocation of `createVpnCustomerGateway`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpncustomergatewayresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvpncustomergatewayresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpncustomergatewayresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvpncustomergatewayresponse
      x-cloudstack-command: createVpnCustomerGateway
      x-cloudstack-async: true
      x-cloudstack-related:
      - updateVpnCustomerGateway
      x-cloudstack-jobresult-schema: '#/components/schemas/VpnCustomerGateway'
  /createVpnGateway:
    get:
      operationId: createVpnGateway
      summary: Creates site to site VPN local gateway
      description: |-
        Creates site to site VPN local gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createVpnGateway
          default: createVpnGateway
      - $ref: '#/components/parameters/response'
      - name: vpcid
        in: query
        description: Public IP address id of the VPN gateway
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the VPN to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: ipaddressid
        in: query
        description: the public IP address ID for which VPN gateway is being enabled. By default the source NAT IP or router IP will be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      responses:
        '200':
          description: Successful invocation of `createVpnGateway`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpngatewayresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - createvpngatewayresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createvpngatewayresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createvpngatewayresponse
      x-cloudstack-command: createVpnGateway
      x-cloudstack-async: true
      x-cloudstack-related:
      - updateVpnGateway
      x-cloudstack-jobresult-schema: '#/components/schemas/VpnGateway'
  /createWebhook:
    get:
      operationId: createWebhook
      summary: Creates a Webhook
      tags:
      - Webhook
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createWebhook
          default: createWebhook
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name for the Webhook
        required: true
        schema:
          type: string
          maxLength: 255
      - name: payloadurl
        in: query
        description: Payload URL of the Webhook
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: An optional account for the Webhook. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: Description for the Webhook
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: projectid
        in: query
        description: Project for the Webhook
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: scope
        in: query
        description: Scope of the Webhook
        schema:
          type: string
          maxLength: 255
      - name: secretkey
        in: query
        description: Secret key of the Webhook
        schema:
          type: string
          maxLength: 255
      - name: sslverification
        in: query
        description: If set to true then SSL verification will be done for the Webhook otherwise not
        schema:
          type: boolean
      - name: state
        in: query
        description: State of the Webhook
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `createWebhook`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createwebhookresponse:
                    oneOf:
                    - &id080
                      $ref: '#/components/schemas/Webhook'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id080
                        - type: array
                          items: *id080
                required:
                - createwebhookresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createwebhookresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createwebhookresponse
      x-cloudstack-command: createWebhook
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /createZone:
    get:
      operationId: createZone
      summary: Creates a Zone.
      tags:
      - Zone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: createZone
          default: createZone
      - $ref: '#/components/parameters/response'
      - name: dns1
        in: query
        description: The first DNS for the Zone
        required: true
        schema:
          type: string
          maxLength: 255
      - name: internaldns1
        in: query
        description: The first internal DNS for the Zone
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Zone
        required: true
        schema:
          type: string
          maxLength: 255
      - name: networktype
        in: query
        description: Network type of the zone, can be Basic or Advanced
        required: true
        schema:
          type: string
          maxLength: 255
      - name: allocationstate
        in: query
        description: Allocation state of this Zone for allocation of new resources
        schema:
          type: string
          maxLength: 255
      - name: dns2
        in: query
        description: The second DNS for the Zone
        schema:
          type: string
          maxLength: 255
      - name: domain
        in: query
        description: Network domain name for the networks in the zone
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain, null for public zones
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: guestcidraddress
        in: query
        description: The guest CIDR address for the Zone
        schema:
          type: string
          maxLength: 255
      - name: internaldns2
        in: query
        description: The second internal DNS for the Zone
        schema:
          type: string
          maxLength: 255
      - name: ip6dns1
        in: query
        description: The first DNS for IPv6 network in the Zone
        schema:
          type: string
          maxLength: 255
      - name: ip6dns2
        in: query
        description: The second DNS for IPv6 network in the Zone
        schema:
          type: string
          maxLength: 255
      - name: isedge
        in: query
        description: True if the zone is an edge zone, false otherwise
        schema:
          type: boolean
        x-cloudstack-since: 4.18.0
      - name: localstorageenabled
        in: query
        description: True if local storage offering enabled, false otherwise
        schema:
          type: boolean
      - name: securitygroupenabled
        in: query
        description: True if network is security group enabled, false otherwise
        schema:
          type: boolean
      - name: storageaccessgroups
        in: query
        description: comma separated list of storage access groups for the hosts in the zone. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.21.0
      responses:
        '200':
          description: Successful invocation of `createZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createzoneresponse:
                    oneOf:
                    - &id081
                      $ref: '#/components/schemas/Zone'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id081
                        - type: array
                          items: *id081
                required:
                - createzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  createzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - createzoneresponse
      x-cloudstack-command: createZone
      x-cloudstack-async: false
      x-cloudstack-related:
      - listZones
  /declareHostAsDegraded:
    get:
      operationId: declareHostAsDegraded
      summary: Declare host as 'Degraded'.
      description: |-
        Declare host as 'Degraded'. Host must be on 'Disconnected' or 'Alert' state. The ADMIN must be sure that there are no Instances running on the respective host otherwise this command might corrupted Instances that were running on the 'Degraded' host.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DeclareHostAsDegraded
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: declareHostAsDegraded
          default: declareHostAsDegraded
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Host ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `declareHostAsDegraded`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  declarehostasdegradedresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - declarehostasdegradedresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  declarehostasdegradedresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - declarehostasdegradedresponse
      x-cloudstack-command: declareHostAsDegraded
      x-cloudstack-async: true
      x-cloudstack-since: 4.16.0.0
      x-cloudstack-related:
      - reconnectHost
      x-cloudstack-jobresult-schema: '#/components/schemas/Host'
  /dedicateBgpPeer:
    get:
      operationId: dedicateBgpPeer
      summary: Dedicates an existing Bgp Peer to an account or a domain.
      description: |-
        Dedicates an existing Bgp Peer to an account or a domain.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BgpPeer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: dedicateBgpPeer
          default: dedicateBgpPeer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the Bgp Peer
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - dedicateBgpPeer
        - listBgpPeers
        - releaseBgpPeer
      - name: account
        in: query
        description: account who will own the Bgp Peer
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: domain ID of the account owning the Bgp Peer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: projectid
        in: query
        description: project who will own the Bgp Peer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `dedicateBgpPeer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatebgppeerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - dedicatebgppeerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatebgppeerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - dedicatebgppeerresponse
      x-cloudstack-command: dedicateBgpPeer
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - listBgpPeers
      - releaseBgpPeer
      x-cloudstack-jobresult-schema: '#/components/schemas/BgpPeer'
  /dedicateCluster:
    get:
      operationId: dedicateCluster
      summary: Dedicate an existing cluster
      description: |-
        Dedicate an existing cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: dedicateCluster
          default: dedicateCluster
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: The ID of the Cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: domainid
        in: query
        description: The ID of the containing domain
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: account
        in: query
        description: The name of the account which needs dedication. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `dedicateCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicateclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - dedicateclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicateclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - dedicateclusterresponse
      x-cloudstack-command: dedicateCluster
      x-cloudstack-async: true
      x-cloudstack-related:
      - listDedicatedClusters
      x-cloudstack-jobresult-schema: '#/components/schemas/DedicateClusterResult'
  /dedicateGuestVlanRange:
    get:
      operationId: dedicateGuestVlanRange
      summary: Dedicates a guest vlan range to an account
      tags:
      - GuestVlanRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: dedicateGuestVlanRange
          default: dedicateGuestVlanRange
      - $ref: '#/components/parameters/response'
      - name: physicalnetworkid
        in: query
        description: Physical Network ID of the VLAN
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: vlanrange
        in: query
        description: Guest VLAN range to be dedicated
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: Account who will own the VLAN
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Domain ID of the Account owning a VLAN
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: projectid
        in: query
        description: Project who will own the VLAN
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `dedicateGuestVlanRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicateguestvlanrangeresponse:
                    oneOf:
                    - &id082
                      $ref: '#/components/schemas/DedicateGuestVlanRangeResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id082
                        - type: array
                          items: *id082
                required:
                - dedicateguestvlanrangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicateguestvlanrangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - dedicateguestvlanrangeresponse
      x-cloudstack-command: dedicateGuestVlanRange
      x-cloudstack-async: false
  /dedicateHost:
    get:
      operationId: dedicateHost
      summary: Dedicates a host.
      description: |-
        Dedicates a host.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Host
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: dedicateHost
          default: dedicateHost
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: The ID of the containing domain
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: hostid
        in: query
        description: The ID of the host to update
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: account
        in: query
        description: The name of the account which needs dedication. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `dedicateHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatehostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - dedicatehostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatehostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - dedicatehostresponse
      x-cloudstack-command: dedicateHost
      x-cloudstack-async: true
      x-cloudstack-related:
      - listDedicatedHosts
      x-cloudstack-jobresult-schema: '#/components/schemas/DedicateHostResult'
  /dedicateIpv4SubnetForZone:
    get:
      operationId: dedicateIpv4SubnetForZone
      summary: Dedicates an existing IPv4 subnet for a zone to an account or a domain.
      description: |-
        Dedicates an existing IPv4 subnet for a zone to an account or a domain.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Ipv4SubnetForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: dedicateIpv4SubnetForZone
          default: dedicateIpv4SubnetForZone
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the guest network IPv4 subnet
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - dedicateIpv4SubnetForZone
      - name: account
        in: query
        description: account who will own the IPv4 subnet
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: domain ID of the account owning the IPv4 subnet
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: projectid
        in: query
        description: project who will own the IPv4 subnet
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `dedicateIpv4SubnetForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicateipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - dedicateipv4subnetforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicateipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - dedicateipv4subnetforzoneresponse
      x-cloudstack-command: dedicateIpv4SubnetForZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv4SubnetForZone'
  /dedicatePod:
    get:
      operationId: dedicatePod
      summary: Dedicates a Pod.
      description: |-
        Dedicates a Pod.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Pod
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: dedicatePod
          default: dedicatePod
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: The ID of the containing domain
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: podid
        in: query
        description: The ID of the Pod
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: account
        in: query
        description: The name of the account which needs dedication. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `dedicatePod`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatepodresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - dedicatepodresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatepodresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - dedicatepodresponse
      x-cloudstack-command: dedicatePod
      x-cloudstack-async: true
      x-cloudstack-related:
      - listDedicatedPods
      x-cloudstack-jobresult-schema: '#/components/schemas/DedicatePodResult'
  /dedicatePublicIpRange:
    get:
      operationId: dedicatePublicIpRange
      summary: Dedicates a Public IP range to an account
      tags:
      - PublicIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: dedicatePublicIpRange
          default: dedicatePublicIpRange
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: Domain ID of the account owning a VLAN
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: The ID of the VLAN IP range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVlanIpRange
        - dedicatePublicIpRange
        - updateVlanIpRange
      - name: account
        in: query
        description: Account who will own the VLAN
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: Project who will own the VLAN
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      responses:
        '200':
          description: Successful invocation of `dedicatePublicIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatepubliciprangeresponse:
                    oneOf:
                    - &id083
                      $ref: '#/components/schemas/VlanIpRange'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id083
                        - type: array
                          items: *id083
                required:
                - dedicatepubliciprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatepubliciprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - dedicatepubliciprangeresponse
      x-cloudstack-command: dedicatePublicIpRange
      x-cloudstack-async: false
      x-cloudstack-related:
      - createVlanIpRange
      - updateVlanIpRange
  /dedicateZone:
    get:
      operationId: dedicateZone
      summary: Dedicates a zones.
      description: |-
        Dedicates a zones.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Zone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: dedicateZone
          default: dedicateZone
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: The ID of the containing domain
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: zoneid
        in: query
        description: The ID of the zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: The name of the account which needs dedication. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `dedicateZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatezoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - dedicatezoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  dedicatezoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - dedicatezoneresponse
      x-cloudstack-command: dedicateZone
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/DedicateZoneResult'
  /deleteASNRange:
    get:
      operationId: deleteASNRange
      summary: deletes a range of Autonomous Systems for BGP Dynamic Routing
      tags:
      - ASNRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteASNRange
          default: deleteASNRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the AS range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteASNRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteasnrangeresponse:
                    oneOf:
                    - &id084
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id084
                        - type: array
                          items: *id084
                required:
                - deleteasnrangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteasnrangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteasnrangeresponse
      x-cloudstack-command: deleteASNRange
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /deleteAccount:
    get:
      operationId: deleteAccount
      summary: Deletes an Account and all Users associated with this Account
      description: |-
        Deletes an Account and all Users associated with this Account

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteAccount
          default: deleteAccount
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Account id
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      responses:
        '200':
          description: Successful invocation of `deleteAccount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteaccountresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteaccountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteaccountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteaccountresponse
      x-cloudstack-command: deleteAccount
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteAccountFromProject:
    get:
      operationId: deleteAccountFromProject
      summary: Deletes Account from the project
      description: |-
        Deletes Account from the project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteAccountFromProject
          default: deleteAccountFromProject
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Name of the Account to be removed from the project
        required: true
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: ID of the project to remove the Account from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `deleteAccountFromProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteaccountfromprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteaccountfromprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteaccountfromprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteaccountfromprojectresponse
      x-cloudstack-command: deleteAccountFromProject
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteAffinityGroup:
    get:
      operationId: deleteAffinityGroup
      summary: Deletes affinity group
      description: |-
        Deletes affinity group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AffinityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteAffinityGroup
          default: deleteAffinityGroup
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The account of the affinity group. Must be specified with domain ID
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID of account owning the affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: The ID of the affinity group. Mutually exclusive with name parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAffinityGroup
        - listAffinityGroups
      - name: name
        in: query
        description: The name of the affinity group. Mutually exclusive with ID parameter
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: The project of the affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `deleteAffinityGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteaffinitygroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteaffinitygroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteaffinitygroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteaffinitygroupresponse
      x-cloudstack-command: deleteAffinityGroup
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteAlerts:
    get:
      operationId: deleteAlerts
      summary: Delete one or more alerts.
      tags:
      - Alert
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteAlerts
          default: deleteAlerts
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: End date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: ids
        in: query
        description: The IDs of the alerts. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listAlertTypes
        - listAlerts
      - name: startdate
        in: query
        description: Start date range to delete alerts (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: type
        in: query
        description: Delete by alert type
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteAlerts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletealertsresponse:
                    oneOf:
                    - &id085
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id085
                        - type: array
                          items: *id085
                required:
                - deletealertsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletealertsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletealertsresponse
      x-cloudstack-command: deleteAlerts
      x-cloudstack-async: false
  /deleteAutoScalePolicy:
    get:
      operationId: deleteAutoScalePolicy
      summary: Deletes a autoscale policy.
      description: |-
        Deletes a autoscale policy.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScalePolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteAutoScalePolicy
          default: deleteAutoScalePolicy
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the autoscale policy
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listAutoScalePolicies
      responses:
        '200':
          description: Successful invocation of `deleteAutoScalePolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteautoscalepolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteautoscalepolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteautoscalepolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteautoscalepolicyresponse
      x-cloudstack-command: deleteAutoScalePolicy
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteAutoScaleVmGroup:
    get:
      operationId: deleteAutoScaleVmGroup
      summary: Deletes an autoscale Instance group.
      description: |-
        Deletes an autoscale Instance group.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScaleVmGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteAutoScaleVmGroup
          default: deleteAutoScaleVmGroup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the autoscale group
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: cleanup
        in: query
        description: True if all VMs have to be cleaned up, false otherwise
        schema:
          type: boolean
        x-cloudstack-since: 4.18.0
      responses:
        '200':
          description: Successful invocation of `deleteAutoScaleVmGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteautoscalevmgroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteautoscalevmgroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteautoscalevmgroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteautoscalevmgroupresponse
      x-cloudstack-command: deleteAutoScaleVmGroup
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteAutoScaleVmProfile:
    get:
      operationId: deleteAutoScaleVmProfile
      summary: Deletes a autoscale Instance profile.
      description: |-
        Deletes a autoscale Instance profile.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScaleVmProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteAutoScaleVmProfile
          default: deleteAutoScaleVmProfile
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the autoscale profile
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAutoScaleVmProfile
        - listAutoScaleVmProfiles
        - updateAutoScaleVmProfile
      responses:
        '200':
          description: Successful invocation of `deleteAutoScaleVmProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteautoscalevmprofileresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteautoscalevmprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteautoscalevmprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteautoscalevmprofileresponse
      x-cloudstack-command: deleteAutoScaleVmProfile
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteBackup:
    get:
      operationId: deleteBackup
      summary: Delete Instance backup
      description: |-
        Delete Instance backup

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Backup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBackup
          default: deleteBackup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the Instance backup
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: forced
        in: query
        description: Force the deletion of backup which removes the entire backup chain but keep Instance in Backup Offering
        schema:
          type: boolean
        x-cloudstack-since: 4.18.0.0
      responses:
        '200':
          description: Successful invocation of `deleteBackup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebackupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletebackupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebackupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebackupresponse
      x-cloudstack-command: deleteBackup
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteBackupOffering:
    get:
      operationId: deleteBackupOffering
      summary: Deletes a backup offering
      tags:
      - BackupOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBackupOffering
          default: deleteBackupOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the backup offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneBackupOffering
        - createBackupOffering
        - importBackupOffering
        - listBackupOfferings
        - listBackupProviderOfferings
        - updateBackupOffering
      responses:
        '200':
          description: Successful invocation of `deleteBackupOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebackupofferingresponse:
                    oneOf:
                    - &id086
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id086
                        - type: array
                          items: *id086
                required:
                - deletebackupofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebackupofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebackupofferingresponse
      x-cloudstack-command: deleteBackupOffering
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
  /deleteBackupRepository:
    get:
      operationId: deleteBackupRepository
      summary: delete a backup repository
      tags:
      - BackupRepository
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBackupRepository
          default: deleteBackupRepository
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the backup repository to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBackupRepository
        - listBackupRepositories
        - updateBackupRepository
      responses:
        '200':
          description: Successful invocation of `deleteBackupRepository`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebackuprepositoryresponse:
                    oneOf:
                    - &id087
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id087
                        - type: array
                          items: *id087
                required:
                - deletebackuprepositoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebackuprepositoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebackuprepositoryresponse
      x-cloudstack-command: deleteBackupRepository
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /deleteBackupSchedule:
    get:
      operationId: deleteBackupSchedule
      summary: Deletes the backup schedule of a Instance
      tags:
      - BackupSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBackupSchedule
          default: deleteBackupSchedule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the backup schedule to be deleted. It has precedence over the 'virtualmachineid' parameter, i.e., when the 'id' parameter is specified, the 'virtualmachineid' parameter will be ignored.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.20.1
        x-cloudstack-related:
        - listBackupSchedule
      - name: virtualmachineid
        in: query
        description: ID of the VM from which all backup schedules will be deleted.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `deleteBackupSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebackupscheduleresponse:
                    oneOf:
                    - &id088
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id088
                        - type: array
                          items: *id088
                required:
                - deletebackupscheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebackupscheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebackupscheduleresponse
      x-cloudstack-command: deleteBackupSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
  /deleteBaremetalRct:
    get:
      operationId: deleteBaremetalRct
      summary: Deletes baremetal rack configuration text
      description: |-
        Deletes baremetal rack configuration text

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BaremetalRct
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBaremetalRct
          default: deleteBaremetalRct
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: RCT id
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteBaremetalRct`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebaremetalrctresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletebaremetalrctresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebaremetalrctresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebaremetalrctresponse
      x-cloudstack-command: deleteBaremetalRct
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteBgpPeer:
    get:
      operationId: deleteBgpPeer
      summary: Deletes an existing Bgp Peer.
      description: |-
        Deletes an existing Bgp Peer.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BgpPeer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBgpPeer
          default: deleteBgpPeer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the Bgp Peer
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createBgpPeer
        - dedicateBgpPeer
        - listBgpPeers
        - releaseBgpPeer
        - updateBgpPeer
      responses:
        '200':
          description: Successful invocation of `deleteBgpPeer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebgppeerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletebgppeerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebgppeerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebgppeerresponse
      x-cloudstack-command: deleteBgpPeer
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteBigSwitchBcfDevice:
    get:
      operationId: deleteBigSwitchBcfDevice
      summary: delete a BigSwitch BCF Controller device
      description: |-
        delete a BigSwitch BCF Controller device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BigSwitchBcfDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBigSwitchBcfDevice
          default: deleteBigSwitchBcfDevice
      - $ref: '#/components/parameters/response'
      - name: bcfdeviceid
        in: query
        description: BigSwitch device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listBigSwitchBcfDevices
      responses:
        '200':
          description: Successful invocation of `deleteBigSwitchBcfDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebigswitchbcfdeviceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletebigswitchbcfdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebigswitchbcfdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebigswitchbcfdeviceresponse
      x-cloudstack-command: deleteBigSwitchBcfDevice
      x-cloudstack-async: true
      x-cloudstack-since: 4.6.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteBrocadeVcsDevice:
    get:
      operationId: deleteBrocadeVcsDevice
      summary: delete a Brocade VCS Switch
      description: |-
        delete a Brocade VCS Switch

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BrocadeVcsDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBrocadeVcsDevice
          default: deleteBrocadeVcsDevice
      - $ref: '#/components/parameters/response'
      - name: vcsdeviceid
        in: query
        description: Brocade Switch ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteBrocadeVcsDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebrocadevcsdeviceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletebrocadevcsdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebrocadevcsdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebrocadevcsdeviceresponse
      x-cloudstack-command: deleteBrocadeVcsDevice
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteBucket:
    get:
      operationId: deleteBucket
      summary: Deletes an empty Bucket.
      tags:
      - Bucket
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteBucket
          default: deleteBucket
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Bucket
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createBucket
        - listBuckets
      responses:
        '200':
          description: Successful invocation of `deleteBucket`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebucketresponse:
                    oneOf:
                    - &id089
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id089
                        - type: array
                          items: *id089
                required:
                - deletebucketresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletebucketresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletebucketresponse
      x-cloudstack-command: deleteBucket
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /deleteCiscoAsa1000vResource:
    get:
      operationId: deleteCiscoAsa1000vResource
      summary: Deletes a Cisco ASA 1000v appliance
      tags:
      - CiscoAsa1000vResource
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteCiscoAsa1000vResource
          default: deleteCiscoAsa1000vResource
      - $ref: '#/components/parameters/response'
      - name: resourceid
        in: query
        description: Cisco ASA 1000v resource ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCiscoAsa1000vResource
        - listCiscoAsa1000vResources
      responses:
        '200':
          description: Successful invocation of `deleteCiscoAsa1000vResource`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteciscoasa1000vresourceresponse:
                    oneOf:
                    - &id090
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id090
                        - type: array
                          items: *id090
                required:
                - deleteciscoasa1000vresourceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteciscoasa1000vresourceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteciscoasa1000vresourceresponse
      x-cloudstack-command: deleteCiscoAsa1000vResource
      x-cloudstack-async: false
  /deleteCiscoNexusVSM:
    get:
      operationId: deleteCiscoNexusVSM
      summary: delete a Cisco Nexus VSM device
      description: |-
        delete a Cisco Nexus VSM device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - CiscoNexusVSM
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteCiscoNexusVSM
          default: deleteCiscoNexusVSM
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the Cisco Nexus 1000v VSM device to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableCiscoNexusVSM
        - listCiscoNexusVSMs
      responses:
        '200':
          description: Successful invocation of `deleteCiscoNexusVSM`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletecisconexusvsmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletecisconexusvsmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletecisconexusvsmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletecisconexusvsmresponse
      x-cloudstack-command: deleteCiscoNexusVSM
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteCiscoVnmcResource:
    get:
      operationId: deleteCiscoVnmcResource
      summary: Deletes a Cisco Vnmc controller
      tags:
      - CiscoVnmcResource
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteCiscoVnmcResource
          default: deleteCiscoVnmcResource
      - $ref: '#/components/parameters/response'
      - name: resourceid
        in: query
        description: Cisco Vnmc resource ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCiscoVnmcResource
        - listCiscoVnmcResources
      responses:
        '200':
          description: Successful invocation of `deleteCiscoVnmcResource`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteciscovnmcresourceresponse:
                    oneOf:
                    - &id091
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id091
                        - type: array
                          items: *id091
                required:
                - deleteciscovnmcresourceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteciscovnmcresourceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteciscovnmcresourceresponse
      x-cloudstack-command: deleteCiscoVnmcResource
      x-cloudstack-async: false
  /deleteCluster:
    get:
      operationId: deleteCluster
      summary: Deletes a cluster.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteCluster
          default: deleteCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The cluster ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      responses:
        '200':
          description: Successful invocation of `deleteCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteclusterresponse:
                    oneOf:
                    - &id092
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id092
                        - type: array
                          items: *id092
                required:
                - deleteclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteclusterresponse
      x-cloudstack-command: deleteCluster
      x-cloudstack-async: false
  /deleteCniConfiguration:
    get:
      operationId: deleteCniConfiguration
      summary: Deletes a CNI Configuration
      tags:
      - CniConfiguration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteCniConfiguration
          default: deleteCniConfiguration
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Userdata
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listCniConfiguration
      - name: account
        in: query
        description: An optional account for the userdata. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the userdata. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: projectid
        in: query
        description: An optional project for the userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `deleteCniConfiguration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletecniconfigurationresponse:
                    oneOf:
                    - &id093
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id093
                        - type: array
                          items: *id093
                required:
                - deletecniconfigurationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletecniconfigurationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletecniconfigurationresponse
      x-cloudstack-command: deleteCniConfiguration
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /deleteCondition:
    get:
      operationId: deleteCondition
      summary: Removes a condition for Instance auto scaling
      description: |-
        Removes a condition for Instance auto scaling

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Condition
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteCondition
          default: deleteCondition
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the condition.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteCondition`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteconditionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteconditionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteconditionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteconditionresponse
      x-cloudstack-command: deleteCondition
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteCounter:
    get:
      operationId: deleteCounter
      summary: Deletes a counter for Instance auto scaling
      description: |-
        Deletes a counter for Instance auto scaling

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Counter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteCounter
          default: deleteCounter
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the counter
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createCounter
      responses:
        '200':
          description: Successful invocation of `deleteCounter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletecounterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletecounterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletecounterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletecounterresponse
      x-cloudstack-command: deleteCounter
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteCustomAction:
    get:
      operationId: deleteCustomAction
      summary: Delete the custom action
      tags:
      - CustomAction
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteCustomAction
          default: deleteCustomAction
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: uuid of the custom action
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCustomAction
        - listCustomActions
      responses:
        '200':
          description: Successful invocation of `deleteCustomAction`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletecustomactionresponse:
                    oneOf:
                    - &id094
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id094
                        - type: array
                          items: *id094
                required:
                - deletecustomactionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletecustomactionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletecustomactionresponse
      x-cloudstack-command: deleteCustomAction
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /deleteDiskOffering:
    get:
      operationId: deleteDiskOffering
      summary: Updates a disk offering.
      tags:
      - DiskOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteDiskOffering
          default: deleteDiskOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the disk offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteDiskOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletediskofferingresponse:
                    oneOf:
                    - &id095
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id095
                        - type: array
                          items: *id095
                required:
                - deletediskofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletediskofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletediskofferingresponse
      x-cloudstack-command: deleteDiskOffering
      x-cloudstack-async: false
  /deleteDnsRecord:
    get:
      operationId: deleteDnsRecord
      summary: Deletes a DNS record from the external provider
      description: |-
        Deletes a DNS record from the external provider

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DnsRecord
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteDnsRecord
          default: deleteDnsRecord
      - $ref: '#/components/parameters/response'
      - name: dnszoneid
        in: query
        description: The ID of the DNS zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDnsZones
      - name: name
        in: query
        required: true
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteDnsRecord`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletednsrecordresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletednsrecordresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletednsrecordresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletednsrecordresponse
      x-cloudstack-command: deleteDnsRecord
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteDnsServer:
    get:
      operationId: deleteDnsServer
      summary: Removes a DNS server integration
      description: |-
        Removes a DNS server integration

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DnsServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteDnsServer
          default: deleteDnsServer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the DNS server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addDnsServer
        - listDnsServers
        - updateDnsServer
      - name: cleanup
        in: query
        description: 'If true, all associated DNS zones will be cleaned up when the server is removed. Default: true'
        schema:
          type: boolean
        x-cloudstack-related:
        - listDnsZones
      - name: unmanage
        in: query
        description: 'If true, the DNS zone is only removed from CloudStack (unmanaged); if false, it is removed from both CloudStack and the DNS provider. Default: false'
        schema:
          type: boolean
        x-cloudstack-related:
        - listDnsZones
      responses:
        '200':
          description: Successful invocation of `deleteDnsServer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletednsserverresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletednsserverresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletednsserverresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletednsserverresponse
      x-cloudstack-command: deleteDnsServer
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteDnsZone:
    get:
      operationId: deleteDnsZone
      summary: Removes a DNS Zone from CloudStack and the external provider
      description: |-
        Removes a DNS Zone from CloudStack and the external provider

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DnsZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteDnsZone
          default: deleteDnsZone
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the DNS zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDnsZones
      - name: unmanage
        in: query
        description: 'If true, removes the DNS zone only from CloudStack; if false, removes it from both CloudStack and the DNS provider. Default: false'
        schema:
          type: boolean
        x-cloudstack-related:
        - listDnsZones
      responses:
        '200':
          description: Successful invocation of `deleteDnsZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletednszoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletednszoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletednszoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletednszoneresponse
      x-cloudstack-command: deleteDnsZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteDomain:
    get:
      operationId: deleteDomain
      summary: Deletes a specified domain
      description: |-
        Deletes a specified domain

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Domain
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteDomain
          default: deleteDomain
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of domain to delete
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: cleanup
        in: query
        description: True if all domain resources (child domains, Accounts) have to be cleaned up, false otherwise
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `deleteDomain`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletedomainresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletedomainresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletedomainresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletedomainresponse
      x-cloudstack-command: deleteDomain
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteEgressFirewallRule:
    get:
      operationId: deleteEgressFirewallRule
      summary: Deletes an egress firewall rule
      description: |-
        Deletes an egress firewall rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - EgressFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteEgressFirewallRule
          default: deleteEgressFirewallRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the firewall rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      responses:
        '200':
          description: Successful invocation of `deleteEgressFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteegressfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteegressfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteegressfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteegressfirewallruleresponse
      x-cloudstack-command: deleteEgressFirewallRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteEvents:
    get:
      operationId: deleteEvents
      summary: Delete one or more events.
      tags:
      - Event
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteEvents
          default: deleteEvents
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: End date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: ids
        in: query
        description: The IDs of the events. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: startdate
        in: query
        description: Start date range to delete events (including) this date (use format "yyyy-MM-dd" or the new format "yyyy-MM-ddThh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: type
        in: query
        description: Delete by event type
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteEvents`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteeventsresponse:
                    oneOf:
                    - &id096
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id096
                        - type: array
                          items: *id096
                required:
                - deleteeventsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteeventsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteeventsresponse
      x-cloudstack-command: deleteEvents
      x-cloudstack-async: false
  /deleteExtension:
    get:
      operationId: deleteExtension
      summary: Delete the extensions
      tags:
      - Extension
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteExtension
          default: deleteExtension
      - $ref: '#/components/parameters/response'
      - name: cleanup
        in: query
        description: Whether to cleanup files for the extension. If true, the extension files will be deleted from all the management servers.
        schema:
          type: boolean
        x-cloudstack-related:
        - deleteExtension
        - listExtensions
        - unregisterExtension
        - updateExtension
      - name: id
        in: query
        description: ID of the extension
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - deleteExtension
        - listExtensions
        - unregisterExtension
        - updateExtension
      responses:
        '200':
          description: Successful invocation of `deleteExtension`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteextensionresponse:
                    oneOf:
                    - &id097
                      $ref: '#/components/schemas/Extension'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id097
                        - type: array
                          items: *id097
                required:
                - deleteextensionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteextensionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteextensionresponse
      x-cloudstack-command: deleteExtension
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - listExtensions
      - unregisterExtension
      - updateExtension
  /deleteFirewallRule:
    get:
      operationId: deleteFirewallRule
      summary: Deletes a firewall rule
      description: |-
        Deletes a firewall rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - FirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteFirewallRule
          default: deleteFirewallRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the firewall rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updatePortForwardingRule
      responses:
        '200':
          description: Successful invocation of `deleteFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletefirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletefirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletefirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletefirewallruleresponse
      x-cloudstack-command: deleteFirewallRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteGlobalLoadBalancerRule:
    get:
      operationId: deleteGlobalLoadBalancerRule
      summary: Deletes a global load balancer rule.
      description: |-
        Deletes a global load balancer rule.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GlobalLoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteGlobalLoadBalancerRule
          default: deleteGlobalLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the global load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGlobalLoadBalancerRules
        - updateGlobalLoadBalancerRule
      responses:
        '200':
          description: Successful invocation of `deleteGlobalLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletegloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletegloballoadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletegloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletegloballoadbalancerruleresponse
      x-cloudstack-command: deleteGlobalLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteGpuCard:
    get:
      operationId: deleteGpuCard
      summary: Deletes a GPU card definition from the system
      tags:
      - GpuCard
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteGpuCard
          default: deleteGpuCard
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the GPU card
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteGpuCard`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletegpucardresponse:
                    oneOf:
                    - &id098
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id098
                        - type: array
                          items: *id098
                required:
                - deletegpucardresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletegpucardresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletegpucardresponse
      x-cloudstack-command: deleteGpuCard
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /deleteGpuDevice:
    get:
      operationId: deleteGpuDevice
      summary: Deletes a vGPU profile from the system
      tags:
      - GpuDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteGpuDevice
          default: deleteGpuDevice
      - $ref: '#/components/parameters/response'
      - name: ids
        in: query
        description: comma separated list of IDs of the GPU device. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createGpuDevice
        - discoverGpuDevices
        - listGpuDevices
        - updateGpuDevice
      responses:
        '200':
          description: Successful invocation of `deleteGpuDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletegpudeviceresponse:
                    oneOf:
                    - &id099
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id099
                        - type: array
                          items: *id099
                required:
                - deletegpudeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletegpudeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletegpudeviceresponse
      x-cloudstack-command: deleteGpuDevice
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /deleteGuestNetworkIpv6Prefix:
    get:
      operationId: deleteGuestNetworkIpv6Prefix
      summary: Deletes an existing guest network IPv6 prefix.
      description: |-
        Deletes an existing guest network IPv6 prefix.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GuestNetworkIpv6Prefix
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteGuestNetworkIpv6Prefix
          default: deleteGuestNetworkIpv6Prefix
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the guest network IPv6 prefix
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createGuestNetworkIpv6Prefix
        - listGuestNetworkIpv6Prefixes
      responses:
        '200':
          description: Successful invocation of `deleteGuestNetworkIpv6Prefix`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteguestnetworkipv6prefixresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteguestnetworkipv6prefixresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteguestnetworkipv6prefixresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteguestnetworkipv6prefixresponse
      x-cloudstack-command: deleteGuestNetworkIpv6Prefix
      x-cloudstack-async: true
      x-cloudstack-since: 4.17.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteHSMProfile:
    get:
      operationId: deleteHSMProfile
      summary: Deletes an HSM profile
      tags:
      - HSMProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteHSMProfile
          default: deleteHSMProfile
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the HSM profile
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteHSMProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletehsmprofileresponse:
                    oneOf:
                    - &id100
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id100
                        - type: array
                          items: *id100
                required:
                - deletehsmprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletehsmprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletehsmprofileresponse
      x-cloudstack-command: deleteHSMProfile
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /deleteHost:
    get:
      operationId: deleteHost
      summary: Deletes a host.
      tags:
      - Host
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteHost
          default: deleteHost
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The host ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      - name: forced
        in: query
        description: Force delete the host. All HA enabled Instances running on the host will be put to HA; HA disabled ones will be stopped
        schema:
          type: boolean
      - name: forcedestroylocalstorage
        in: query
        description: Force destroy local storage on this host. All Instances created on this local storage will be destroyed
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `deleteHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletehostresponse:
                    oneOf:
                    - &id101
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id101
                        - type: array
                          items: *id101
                required:
                - deletehostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletehostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletehostresponse
      x-cloudstack-command: deleteHost
      x-cloudstack-async: false
  /deleteImageStore:
    get:
      operationId: deleteImageStore
      summary: Deletes an image store or Secondary Storage.
      tags:
      - ImageStore
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteImageStore
          default: deleteImageStore
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The image store ID or Secondary Storage ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listSwifts
      responses:
        '200':
          description: Successful invocation of `deleteImageStore`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteimagestoreresponse:
                    oneOf:
                    - &id102
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id102
                        - type: array
                          items: *id102
                required:
                - deleteimagestoreresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteimagestoreresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteimagestoreresponse
      x-cloudstack-command: deleteImageStore
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
  /deleteInstanceGroup:
    get:
      operationId: deleteInstanceGroup
      summary: Deletes an Instance group
      tags:
      - InstanceGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteInstanceGroup
          default: deleteInstanceGroup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance group
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateInstanceGroup
      responses:
        '200':
          description: Successful invocation of `deleteInstanceGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteinstancegroupresponse:
                    oneOf:
                    - &id103
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id103
                        - type: array
                          items: *id103
                required:
                - deleteinstancegroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteinstancegroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteinstancegroupresponse
      x-cloudstack-command: deleteInstanceGroup
      x-cloudstack-async: false
  /deleteIpForwardingRule:
    get:
      operationId: deleteIpForwardingRule
      summary: Deletes an IP forwarding rule
      description: |-
        Deletes an IP forwarding rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - IpForwardingRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteIpForwardingRule
          default: deleteIpForwardingRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the forwarding rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updatePortForwardingRule
      responses:
        '200':
          description: Successful invocation of `deleteIpForwardingRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteipforwardingruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteipforwardingruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteipforwardingruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteipforwardingruleresponse
      x-cloudstack-command: deleteIpForwardingRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteIpv4SubnetForGuestNetwork:
    get:
      operationId: deleteIpv4SubnetForGuestNetwork
      summary: Deletes an existing IPv4 subnet for guest network.
      description: |-
        Deletes an existing IPv4 subnet for guest network.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteIpv4SubnetForGuestNetwork
          default: deleteIpv4SubnetForGuestNetwork
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the guest network IPv4 subnet
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpv4SubnetForGuestNetwork
      responses:
        '200':
          description: Successful invocation of `deleteIpv4SubnetForGuestNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteipv4subnetforguestnetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteipv4subnetforguestnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteipv4subnetforguestnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteipv4subnetforguestnetworkresponse
      x-cloudstack-command: deleteIpv4SubnetForGuestNetwork
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteIpv4SubnetForZone:
    get:
      operationId: deleteIpv4SubnetForZone
      summary: Deletes an existing IPv4 subnet for a zone.
      description: |-
        Deletes an existing IPv4 subnet for a zone.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Ipv4SubnetForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteIpv4SubnetForZone
          default: deleteIpv4SubnetForZone
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the guest network IPv4 subnet
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - dedicateIpv4SubnetForZone
      responses:
        '200':
          description: Successful invocation of `deleteIpv4SubnetForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteipv4subnetforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteipv4subnetforzoneresponse
      x-cloudstack-command: deleteIpv4SubnetForZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteIpv6FirewallRule:
    get:
      operationId: deleteIpv6FirewallRule
      summary: Deletes a IPv6 firewall rule
      description: |-
        Deletes a IPv6 firewall rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Ipv6FirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteIpv6FirewallRule
          default: deleteIpv6FirewallRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the IPv6 firewall rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteIpv6FirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteipv6firewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteipv6firewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteipv6firewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteipv6firewallruleresponse
      x-cloudstack-command: deleteIpv6FirewallRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteIso:
    get:
      operationId: deleteIso
      summary: Deletes an ISO file.
      description: |-
        Deletes an ISO file.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Iso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteIso
          default: deleteIso
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the ISO file
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: zoneid
        in: query
        description: The ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteIso`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteisoresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteisoresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteisoresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteisoresponse
      x-cloudstack-command: deleteIso
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteKMSKey:
    get:
      operationId: deleteKMSKey
      summary: Deletes a KMS key (only if not in use)
      description: |-
        Deletes a KMS key (only if not in use)

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KMSKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteKMSKey
          default: deleteKMSKey
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The UUID of the KMS key to delete
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKMSKey
        - listKMSKeys
        - updateKMSKey
      responses:
        '200':
          description: Successful invocation of `deleteKMSKey`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletekmskeyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletekmskeyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletekmskeyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletekmskeyresponse
      x-cloudstack-command: deleteKMSKey
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteKubernetesCluster:
    get:
      operationId: deleteKubernetesCluster
      summary: Deletes a Kubernetes cluster
      description: |-
        Deletes a Kubernetes cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteKubernetesCluster
          default: deleteKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKubernetesCluster
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
        - upgradeKubernetesCluster
      - name: cleanup
        in: query
        description: 'Destroy attached instances of the ExternalManaged Cluster. Default: false'
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: expunge
        in: query
        description: 'Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false'
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      responses:
        '200':
          description: Successful invocation of `deleteKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletekubernetesclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletekubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletekubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletekubernetesclusterresponse
      x-cloudstack-command: deleteKubernetesCluster
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteKubernetesSupportedVersion:
    get:
      operationId: deleteKubernetesSupportedVersion
      summary: Deletes a Kubernetes cluster
      description: |-
        Deletes a Kubernetes cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesSupportedVersion
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteKubernetesSupportedVersion
          default: deleteKubernetesSupportedVersion
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes supported version
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addKubernetesSupportedVersion
        - getUploadParamsForKubernetesSupportedVersion
        - listKubernetesSupportedVersions
        - updateKubernetesSupportedVersion
      responses:
        '200':
          description: Successful invocation of `deleteKubernetesSupportedVersion`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletekubernetessupportedversionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletekubernetessupportedversionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletekubernetessupportedversionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletekubernetessupportedversionresponse
      x-cloudstack-command: deleteKubernetesSupportedVersion
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteLBHealthCheckPolicy:
    get:
      operationId: deleteLBHealthCheckPolicy
      summary: Deletes a load balancer health check policy.
      description: |-
        Deletes a load balancer health check policy.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LBHealthCheckPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteLBHealthCheckPolicy
          default: deleteLBHealthCheckPolicy
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the load balancer health check policy
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteLBHealthCheckPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletelbhealthcheckpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletelbhealthcheckpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletelbhealthcheckpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletelbhealthcheckpolicyresponse
      x-cloudstack-command: deleteLBHealthCheckPolicy
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteLBStickinessPolicy:
    get:
      operationId: deleteLBStickinessPolicy
      summary: Deletes a load balancer stickiness policy.
      description: |-
        Deletes a load balancer stickiness policy.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LBStickinessPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteLBStickinessPolicy
          default: deleteLBStickinessPolicy
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the LB stickiness policy
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createLBStickinessPolicy
        - listLBStickinessPolicies
        - updateLBStickinessPolicy
      responses:
        '200':
          description: Successful invocation of `deleteLBStickinessPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletelbstickinesspolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletelbstickinesspolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletelbstickinesspolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletelbstickinesspolicyresponse
      x-cloudstack-command: deleteLBStickinessPolicy
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteLdapConfiguration:
    get:
      operationId: deleteLdapConfiguration
      summary: Remove an Ldap Configuration
      tags:
      - LdapConfiguration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteLdapConfiguration
          default: deleteLdapConfiguration
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: Linked Domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: hostname
        in: query
        description: Hostname
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: ID of the LDAP configuration
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addLdapConfiguration
        - deleteLdapConfiguration
        - listLdapConfigurations
      - name: port
        in: query
        description: Port
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `deleteLdapConfiguration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteldapconfigurationresponse:
                    oneOf:
                    - &id104
                      $ref: '#/components/schemas/LdapConfiguration'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id104
                        - type: array
                          items: *id104
                required:
                - deleteldapconfigurationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteldapconfigurationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteldapconfigurationresponse
      x-cloudstack-command: deleteLdapConfiguration
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - addLdapConfiguration
      - listLdapConfigurations
  /deleteLoadBalancer:
    get:
      operationId: deleteLoadBalancer
      summary: Deletes an internal load balancer
      description: |-
        Deletes an internal load balancer

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteLoadBalancer
          default: deleteLoadBalancer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Load Balancer
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteLoadBalancer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteloadbalancerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteloadbalancerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteloadbalancerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteloadbalancerresponse
      x-cloudstack-command: deleteLoadBalancer
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteLoadBalancerRule:
    get:
      operationId: deleteLoadBalancerRule
      summary: Deletes a load balancer rule.
      description: |-
        Deletes a load balancer rule.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteLoadBalancerRule
          default: deleteLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      responses:
        '200':
          description: Successful invocation of `deleteLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteloadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteloadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteloadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteloadbalancerruleresponse
      x-cloudstack-command: deleteLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteManagementNetworkIpRange:
    get:
      operationId: deleteManagementNetworkIpRange
      summary: Deletes a management network IP range.
      description: |-
        Deletes a management network IP range. This action is only allowed when no IPs in this range are allocated.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ManagementNetworkIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteManagementNetworkIpRange
          default: deleteManagementNetworkIpRange
      - $ref: '#/components/parameters/response'
      - name: endip
        in: query
        description: The ending IP address.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: UUID of POD, where the IP range belongs to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: startip
        in: query
        description: The starting IP address.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: The vlan id the ip range sits on
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteManagementNetworkIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletemanagementnetworkiprangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletemanagementnetworkiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletemanagementnetworkiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletemanagementnetworkiprangeresponse
      x-cloudstack-command: deleteManagementNetworkIpRange
      x-cloudstack-async: true
      x-cloudstack-since: 4.11.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteNetscalerControlCenter:
    get:
      operationId: deleteNetscalerControlCenter
      summary: Delete Netscaler Control Center
      tags:
      - NetscalerControlCenter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNetscalerControlCenter
          default: deleteNetscalerControlCenter
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Netscaler Control Center ID
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteNetscalerControlCenter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetscalercontrolcenterresponse:
                    oneOf:
                    - &id105
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id105
                        - type: array
                          items: *id105
                required:
                - deletenetscalercontrolcenterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetscalercontrolcenterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletenetscalercontrolcenterresponse
      x-cloudstack-command: deleteNetscalerControlCenter
      x-cloudstack-async: false
  /deleteNetscalerLoadBalancer:
    get:
      operationId: deleteNetscalerLoadBalancer
      summary: delete a netscaler load balancer device
      description: |-
        delete a netscaler load balancer device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetscalerLoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNetscalerLoadBalancer
          default: deleteNetscalerLoadBalancer
      - $ref: '#/components/parameters/response'
      - name: lbdeviceid
        in: query
        description: Netscaler load balancer device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetscalerLoadBalancer
        - configureNetscalerLoadBalancer
        - deployNetscalerVpx
        - listNetscalerLoadBalancers
        - registerNetscalerControlCenter
      responses:
        '200':
          description: Successful invocation of `deleteNetscalerLoadBalancer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetscalerloadbalancerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletenetscalerloadbalancerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetscalerloadbalancerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletenetscalerloadbalancerresponse
      x-cloudstack-command: deleteNetscalerLoadBalancer
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteNetwork:
    get:
      operationId: deleteNetwork
      summary: Deletes a Network
      description: |-
        Deletes a Network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNetwork
          default: deleteNetwork
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - updateNetwork
      - name: forced
        in: query
        description: Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `deleteNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletenetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletenetworkresponse
      x-cloudstack-command: deleteNetwork
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteNetworkACL:
    get:
      operationId: deleteNetworkACL
      summary: Deletes a Network ACL
      description: |-
        Deletes a Network ACL

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkACL
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNetworkACL
          default: deleteNetworkACL
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Network ACL
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACL
        - moveNetworkAclItem
        - updateNetworkACLItem
      responses:
        '200':
          description: Successful invocation of `deleteNetworkACL`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkaclresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletenetworkaclresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkaclresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletenetworkaclresponse
      x-cloudstack-command: deleteNetworkACL
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteNetworkACLList:
    get:
      operationId: deleteNetworkACLList
      summary: Deletes a network ACL
      description: |-
        Deletes a network ACL

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkACLList
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNetworkACLList
          default: deleteNetworkACLList
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network ACL
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
      responses:
        '200':
          description: Successful invocation of `deleteNetworkACLList`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkacllistresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletenetworkacllistresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkacllistresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletenetworkacllistresponse
      x-cloudstack-command: deleteNetworkACLList
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteNetworkDevice:
    get:
      operationId: deleteNetworkDevice
      summary: Deletes network device.
      tags:
      - NetworkDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNetworkDevice
          default: deleteNetworkDevice
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of network device to delete
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `deleteNetworkDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkdeviceresponse:
                    oneOf:
                    - &id106
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id106
                        - type: array
                          items: *id106
                required:
                - deletenetworkdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletenetworkdeviceresponse
      x-cloudstack-command: deleteNetworkDevice
      x-cloudstack-async: false
  /deleteNetworkOffering:
    get:
      operationId: deleteNetworkOffering
      summary: Deletes a network offering.
      tags:
      - NetworkOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNetworkOffering
          default: deleteNetworkOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkOffering
        - listNetworkOfferings
        - updateNetworkOffering
      responses:
        '200':
          description: Successful invocation of `deleteNetworkOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkofferingresponse:
                    oneOf:
                    - &id107
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id107
                        - type: array
                          items: *id107
                required:
                - deletenetworkofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletenetworkofferingresponse
      x-cloudstack-command: deleteNetworkOffering
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
  /deleteNetworkServiceProvider:
    get:
      operationId: deleteNetworkServiceProvider
      summary: Deletes a Network Service Provider.
      description: |-
        Deletes a Network Service Provider.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkServiceProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNetworkServiceProvider
          default: deleteNetworkServiceProvider
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network service provider
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteNetworkServiceProvider`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkserviceproviderresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletenetworkserviceproviderresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletenetworkserviceproviderresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletenetworkserviceproviderresponse
      x-cloudstack-command: deleteNetworkServiceProvider
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteNiciraNvpDevice:
    get:
      operationId: deleteNiciraNvpDevice
      summary: delete a nicira nvp device
      description: |-
        delete a nicira nvp device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NiciraNvpDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteNiciraNvpDevice
          default: deleteNiciraNvpDevice
      - $ref: '#/components/parameters/response'
      - name: nvpdeviceid
        in: query
        description: Nicira device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNiciraNvpDevice
        - listNiciraNvpDevices
      responses:
        '200':
          description: Successful invocation of `deleteNiciraNvpDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteniciranvpdeviceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteniciranvpdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteniciranvpdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteniciranvpdeviceresponse
      x-cloudstack-command: deleteNiciraNvpDevice
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteOauthProvider:
    get:
      operationId: deleteOauthProvider
      summary: Deletes the registered OAuth provider
      tags:
      - OauthProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteOauthProvider
          default: deleteOauthProvider
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: id of the OAuth provider to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteOauthProvider`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteoauthproviderresponse:
                    oneOf:
                    - &id108
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id108
                        - type: array
                          items: *id108
                required:
                - deleteoauthproviderresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteoauthproviderresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteoauthproviderresponse
      x-cloudstack-command: deleteOauthProvider
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /deleteObjectStoragePool:
    get:
      operationId: deleteObjectStoragePool
      summary: Deletes an Object Storage Pool
      tags:
      - ObjectStoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteObjectStoragePool
          default: deleteObjectStoragePool
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The Object Storage ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addObjectStoragePool
        - updateObjectStoragePool
      responses:
        '200':
          description: Successful invocation of `deleteObjectStoragePool`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteobjectstoragepoolresponse:
                    oneOf:
                    - &id109
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id109
                        - type: array
                          items: *id109
                required:
                - deleteobjectstoragepoolresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteobjectstoragepoolresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteobjectstoragepoolresponse
      x-cloudstack-command: deleteObjectStoragePool
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /deleteOpenDaylightController:
    get:
      operationId: deleteOpenDaylightController
      summary: Removes an OpenDyalight controler
      description: |-
        Removes an OpenDyalight controler

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - OpenDaylightController
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteOpenDaylightController
          default: deleteOpenDaylightController
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: OpenDaylight Controller ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - deleteOpenDaylightController
      responses:
        '200':
          description: Successful invocation of `deleteOpenDaylightController`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteopendaylightcontrollerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteopendaylightcontrollerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteopendaylightcontrollerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteopendaylightcontrollerresponse
      x-cloudstack-command: deleteOpenDaylightController
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/OpenDaylightController'
  /deleteOsCategory:
    get:
      operationId: deleteOsCategory
      summary: Deletes an OS category
      tags:
      - OsCategory
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteOsCategory
          default: deleteOsCategory
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the OS category
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addOsCategory
        - listOsCategories
      responses:
        '200':
          description: Successful invocation of `deleteOsCategory`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteoscategoryresponse:
                    oneOf:
                    - &id110
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id110
                        - type: array
                          items: *id110
                required:
                - deleteoscategoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteoscategoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteoscategoryresponse
      x-cloudstack-command: deleteOsCategory
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /deletePaloAltoFirewall:
    get:
      operationId: deletePaloAltoFirewall
      summary: delete a Palo Alto firewall device
      description: |-
        delete a Palo Alto firewall device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PaloAltoFirewall
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deletePaloAltoFirewall
          default: deletePaloAltoFirewall
      - $ref: '#/components/parameters/response'
      - name: fwdeviceid
        in: query
        description: Palo Alto firewall device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addPaloAltoFirewall
        - configurePaloAltoFirewall
        - listPaloAltoFirewalls
      responses:
        '200':
          description: Successful invocation of `deletePaloAltoFirewall`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletepaloaltofirewallresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletepaloaltofirewallresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletepaloaltofirewallresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletepaloaltofirewallresponse
      x-cloudstack-command: deletePaloAltoFirewall
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deletePhysicalNetwork:
    get:
      operationId: deletePhysicalNetwork
      summary: Deletes a Physical Network.
      description: |-
        Deletes a Physical Network.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PhysicalNetwork
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deletePhysicalNetwork
          default: deletePhysicalNetwork
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Physical network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deletePhysicalNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletephysicalnetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletephysicalnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletephysicalnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletephysicalnetworkresponse
      x-cloudstack-command: deletePhysicalNetwork
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deletePod:
    get:
      operationId: deletePod
      summary: Deletes a Pod.
      tags:
      - Pod
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deletePod
          default: deletePod
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Pod
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      responses:
        '200':
          description: Successful invocation of `deletePod`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletepodresponse:
                    oneOf:
                    - &id111
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id111
                        - type: array
                          items: *id111
                required:
                - deletepodresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletepodresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletepodresponse
      x-cloudstack-command: deletePod
      x-cloudstack-async: false
  /deletePortForwardingRule:
    get:
      operationId: deletePortForwardingRule
      summary: Deletes a port forwarding rule
      description: |-
        Deletes a port forwarding rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PortForwardingRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deletePortForwardingRule
          default: deletePortForwardingRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the port forwarding rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      responses:
        '200':
          description: Successful invocation of `deletePortForwardingRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteportforwardingruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteportforwardingruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteportforwardingruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteportforwardingruleresponse
      x-cloudstack-command: deletePortForwardingRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deletePortableIpRange:
    get:
      operationId: deletePortableIpRange
      summary: Deletes a range of portable public IP's associated with a region
      description: |-
        Deletes a range of portable public IP's associated with a region

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PortableIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deletePortableIpRange
          default: deletePortableIpRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the portable ip range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPortableIpRange
      responses:
        '200':
          description: Successful invocation of `deletePortableIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteportableiprangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteportableiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteportableiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteportableiprangeresponse
      x-cloudstack-command: deletePortableIpRange
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deletePrivateGateway:
    get:
      operationId: deletePrivateGateway
      summary: Deletes a Private gateway
      description: |-
        Deletes a Private gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PrivateGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deletePrivateGateway
          default: deletePrivateGateway
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the private gateway
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPrivateGateway
        - listPrivateGateways
      responses:
        '200':
          description: Successful invocation of `deletePrivateGateway`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprivategatewayresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteprivategatewayresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprivategatewayresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteprivategatewayresponse
      x-cloudstack-command: deletePrivateGateway
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteProject:
    get:
      operationId: deleteProject
      summary: Deletes a project
      description: |-
        Deletes a project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteProject
          default: deleteProject
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the project to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: cleanup
        in: query
        description: True if all project resources have to be cleaned up, false otherwise
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      responses:
        '200':
          description: Successful invocation of `deleteProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteprojectresponse
      x-cloudstack-command: deleteProject
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteProjectInvitation:
    get:
      operationId: deleteProjectInvitation
      summary: Deletes project invitation
      description: |-
        Deletes project invitation

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ProjectInvitation
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteProjectInvitation
          default: deleteProjectInvitation
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the invitation
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteProjectInvitation`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprojectinvitationresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteprojectinvitationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprojectinvitationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteprojectinvitationresponse
      x-cloudstack-command: deleteProjectInvitation
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteProjectRole:
    get:
      operationId: deleteProjectRole
      summary: Delete Project roles in CloudStack
      tags:
      - ProjectRole
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteProjectRole
          default: deleteProjectRole
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the project role to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProjectRole
        - listProjectRoles
        - updateProjectRole
      - name: projectid
        in: query
        description: ID of the project from where the role is to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `deleteProjectRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprojectroleresponse:
                    oneOf:
                    - &id112
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id112
                        - type: array
                          items: *id112
                required:
                - deleteprojectroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprojectroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteprojectroleresponse
      x-cloudstack-command: deleteProjectRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
  /deleteProjectRolePermission:
    get:
      operationId: deleteProjectRolePermission
      summary: Deletes a project role permission in the project
      tags:
      - ProjectRolePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteProjectRolePermission
          default: deleteProjectRolePermission
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the project role permission to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: projectid
        in: query
        description: ID of the project where the project role permission is to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteProjectRolePermission`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprojectrolepermissionresponse:
                    oneOf:
                    - &id113
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id113
                        - type: array
                          items: *id113
                required:
                - deleteprojectrolepermissionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteprojectrolepermissionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteprojectrolepermissionresponse
      x-cloudstack-command: deleteProjectRolePermission
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
  /deleteRemoteAccessVpn:
    get:
      operationId: deleteRemoteAccessVpn
      summary: Destroys a l2tp/ipsec remote access VPN
      description: |-
        Destroys a l2tp/ipsec remote access VPN

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - RemoteAccessVpn
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteRemoteAccessVpn
          default: deleteRemoteAccessVpn
      - $ref: '#/components/parameters/response'
      - name: publicipid
        in: query
        description: Public IP address id of the VPN server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      responses:
        '200':
          description: Successful invocation of `deleteRemoteAccessVpn`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteremoteaccessvpnresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteremoteaccessvpnresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteremoteaccessvpnresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteremoteaccessvpnresponse
      x-cloudstack-command: deleteRemoteAccessVpn
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteResourceIcon:
    get:
      operationId: deleteResourceIcon
      summary: Deletes the resource icon from the specified resource(s)
      tags:
      - ResourceIcon
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteResourceIcon
          default: deleteResourceIcon
      - $ref: '#/components/parameters/response'
      - name: resourceids
        in: query
        description: List of resources to upload the icon/image for. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteResourceIcon`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteresourceiconresponse:
                    oneOf:
                    - &id114
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id114
                        - type: array
                          items: *id114
                required:
                - deleteresourceiconresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteresourceiconresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteresourceiconresponse
      x-cloudstack-command: deleteResourceIcon
      x-cloudstack-async: false
      x-cloudstack-since: 4.16.0.0
  /deleteResourceSchedule:
    get:
      operationId: deleteResourceSchedule
      summary: Delete Resource Schedule
      tags:
      - ResourceSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteResourceSchedule
          default: deleteResourceSchedule
      - $ref: '#/components/parameters/response'
      - name: resourceid
        in: query
        description: ID of the resource for which schedules are to be deleted
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: ID of the schedule to be deleted
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: ids
        in: query
        description: comma separated list of schedule ids to be deleted. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `deleteResourceSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteresourcescheduleresponse:
                    oneOf:
                    - &id115
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id115
                        - type: array
                          items: *id115
                required:
                - deleteresourcescheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteresourcescheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteresourcescheduleresponse
      x-cloudstack-command: deleteResourceSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /deleteRole:
    get:
      operationId: deleteRole
      summary: Deletes a role
      tags:
      - Role
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteRole
          default: deleteRole
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - listRoles
        - updateRole
      responses:
        '200':
          description: Successful invocation of `deleteRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteroleresponse:
                    oneOf:
                    - &id116
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id116
                        - type: array
                          items: *id116
                required:
                - deleteroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteroleresponse
      x-cloudstack-command: deleteRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
  /deleteRolePermission:
    get:
      operationId: deleteRolePermission
      summary: Deletes a role permission
      tags:
      - RolePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteRolePermission
          default: deleteRolePermission
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the role permission
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteRolePermission`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleterolepermissionresponse:
                    oneOf:
                    - &id117
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id117
                        - type: array
                          items: *id117
                required:
                - deleterolepermissionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleterolepermissionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleterolepermissionresponse
      x-cloudstack-command: deleteRolePermission
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
  /deleteRoutingFirewallRule:
    get:
      operationId: deleteRoutingFirewallRule
      summary: Deletes a routing firewall rule
      description: |-
        Deletes a routing firewall rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - RoutingFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteRoutingFirewallRule
          default: deleteRoutingFirewallRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the Routing firewall rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPortForwardingRule
        - updatePortForwardingRule
      responses:
        '200':
          description: Successful invocation of `deleteRoutingFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteroutingfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteroutingfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteroutingfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteroutingfirewallruleresponse
      x-cloudstack-command: deleteRoutingFirewallRule
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteSSHKeyPair:
    get:
      operationId: deleteSSHKeyPair
      summary: Deletes a keypair by name
      tags:
      - SSHKeyPair
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteSSHKeyPair
          default: deleteSSHKeyPair
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the keypair
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: The Account associated with the keypair. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID associated with the keypair
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: projectid
        in: query
        description: The project associated with keypair
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `deleteSSHKeyPair`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesshkeypairresponse:
                    oneOf:
                    - &id118
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id118
                        - type: array
                          items: *id118
                required:
                - deletesshkeypairresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesshkeypairresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletesshkeypairresponse
      x-cloudstack-command: deleteSSHKeyPair
      x-cloudstack-async: false
  /deleteSecondaryStagingStore:
    get:
      operationId: deleteSecondaryStagingStore
      summary: Deletes a secondary staging store .
      tags:
      - SecondaryStagingStore
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteSecondaryStagingStore
          default: deleteSecondaryStagingStore
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The staging store ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addImageStoreS3
        - addSecondaryStorage
        - addSwift
        - createSecondaryStagingStore
        - listImageStores
        - listSecondaryStagingStores
        - listSwifts
        - updateCloudToUseObjectStore
        - updateImageStore
      responses:
        '200':
          description: Successful invocation of `deleteSecondaryStagingStore`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesecondarystagingstoreresponse:
                    oneOf:
                    - &id119
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id119
                        - type: array
                          items: *id119
                required:
                - deletesecondarystagingstoreresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesecondarystagingstoreresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletesecondarystagingstoreresponse
      x-cloudstack-command: deleteSecondaryStagingStore
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
  /deleteSecurityGroup:
    get:
      operationId: deleteSecurityGroup
      summary: Deletes security group
      tags:
      - SecurityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteSecurityGroup
          default: deleteSecurityGroup
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The account of the security group. Must be specified with domain ID
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID of account owning the security group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: The ID of the security group. Mutually exclusive with name parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: name
        in: query
        description: The ID of the security group. Mutually exclusive with id parameter
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: The project of the security group
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteSecurityGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesecuritygroupresponse:
                    oneOf:
                    - &id120
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id120
                        - type: array
                          items: *id120
                required:
                - deletesecuritygroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesecuritygroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletesecuritygroupresponse
      x-cloudstack-command: deleteSecurityGroup
      x-cloudstack-async: false
  /deleteServiceOffering:
    get:
      operationId: deleteServiceOffering
      summary: Deletes a service offering.
      tags:
      - ServiceOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteServiceOffering
          default: deleteServiceOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the service offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      responses:
        '200':
          description: Successful invocation of `deleteServiceOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteserviceofferingresponse:
                    oneOf:
                    - &id121
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id121
                        - type: array
                          items: *id121
                required:
                - deleteserviceofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteserviceofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteserviceofferingresponse
      x-cloudstack-command: deleteServiceOffering
      x-cloudstack-async: false
  /deleteServicePackageOffering:
    get:
      operationId: deleteServicePackageOffering
      summary: Delete Service Package
      tags:
      - ServicePackageOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteServicePackageOffering
          default: deleteServicePackageOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The service offering ID
        required: true
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - listRegisteredServicePackages
        - registerNetscalerServicePackage
      responses:
        '200':
          description: Successful invocation of `deleteServicePackageOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteservicepackageofferingresponse:
                    oneOf:
                    - &id122
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id122
                        - type: array
                          items: *id122
                required:
                - deleteservicepackageofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteservicepackageofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteservicepackageofferingresponse
      x-cloudstack-command: deleteServicePackageOffering
      x-cloudstack-async: false
  /deleteSnapshot:
    get:
      operationId: deleteSnapshot
      summary: Deletes a Snapshot of a disk volume.
      description: |-
        Deletes a Snapshot of a disk volume.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Snapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteSnapshot
          default: deleteSnapshot
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Snapshot
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - archiveSnapshot
        - copySnapshot
        - createSnapshotFromVMSnapshot
        - listSnapshots
        - revertSnapshot
      - name: zoneid
        in: query
        description: The ID of the zone for the snapshot
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.19.0
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `deleteSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletesnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletesnapshotresponse
      x-cloudstack-command: deleteSnapshot
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteSnapshotPolicies:
    get:
      operationId: deleteSnapshotPolicies
      summary: Deletes Snapshot policies for the account.
      tags:
      - SnapshotPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteSnapshotPolicies
          default: deleteSnapshotPolicies
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Snapshot policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateSnapshotPolicy
      - name: ids
        in: query
        description: List of Snapshots policy IDs separated by comma. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - updateSnapshotPolicy
      responses:
        '200':
          description: Successful invocation of `deleteSnapshotPolicies`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesnapshotpoliciesresponse:
                    oneOf:
                    - &id123
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id123
                        - type: array
                          items: *id123
                required:
                - deletesnapshotpoliciesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesnapshotpoliciesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletesnapshotpoliciesresponse
      x-cloudstack-command: deleteSnapshotPolicies
      x-cloudstack-async: false
  /deleteSslCert:
    get:
      operationId: deleteSslCert
      summary: Delete a certificate to CloudStack
      tags:
      - SslCert
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteSslCert
          default: deleteSslCert
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of SSL certificate
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - uploadSslCert
      responses:
        '200':
          description: Successful invocation of `deleteSslCert`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesslcertresponse:
                    oneOf:
                    - &id124
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id124
                        - type: array
                          items: *id124
                required:
                - deletesslcertresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletesslcertresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletesslcertresponse
      x-cloudstack-command: deleteSslCert
      x-cloudstack-async: false
  /deleteStaticRoute:
    get:
      operationId: deleteStaticRoute
      summary: Deletes a static route
      description: |-
        Deletes a static route

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StaticRoute
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteStaticRoute
          default: deleteStaticRoute
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the static route
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createStaticRoute
        - listStaticRoutes
      responses:
        '200':
          description: Successful invocation of `deleteStaticRoute`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletestaticrouteresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletestaticrouteresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletestaticrouteresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletestaticrouteresponse
      x-cloudstack-command: deleteStaticRoute
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteStorageNetworkIpRange:
    get:
      operationId: deleteStorageNetworkIpRange
      summary: Deletes a storage network IP Range.
      description: |-
        Deletes a storage network IP Range.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StorageNetworkIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteStorageNetworkIpRange
          default: deleteStorageNetworkIpRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The UUID of the storage network IP range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createStorageNetworkIpRange
        - listStorageNetworkIpRange
      responses:
        '200':
          description: Successful invocation of `deleteStorageNetworkIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletestoragenetworkiprangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletestoragenetworkiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletestoragenetworkiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletestoragenetworkiprangeresponse
      x-cloudstack-command: deleteStorageNetworkIpRange
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteStoragePool:
    get:
      operationId: deleteStoragePool
      summary: Deletes a storage pool.
      tags:
      - StoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteStoragePool
          default: deleteStoragePool
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Storage pool id
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: forced
        in: query
        description: Force destroy storage pool (force expunge volumes in Destroyed state as a part of pool removal)
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `deleteStoragePool`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletestoragepoolresponse:
                    oneOf:
                    - &id125
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id125
                        - type: array
                          items: *id125
                required:
                - deletestoragepoolresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletestoragepoolresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletestoragepoolresponse
      x-cloudstack-command: deleteStoragePool
      x-cloudstack-async: false
  /deleteStratosphereSsp:
    get:
      operationId: deleteStratosphereSsp
      summary: Removes stratosphere ssp server
      tags:
      - StratosphereSsp
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteStratosphereSsp
          default: deleteStratosphereSsp
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: The host ID of ssp server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `deleteStratosphereSsp`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletestratospheresspresponse:
                    oneOf:
                    - &id126
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id126
                        - type: array
                          items: *id126
                required:
                - deletestratospheresspresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletestratospheresspresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletestratospheresspresponse
      x-cloudstack-command: deleteStratosphereSsp
      x-cloudstack-async: false
  /deleteTags:
    get:
      operationId: deleteTags
      summary: Deleting resource tag(s)
      description: |-
        Deleting resource tag(s)

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Tag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTags
          default: deleteTags
      - $ref: '#/components/parameters/response'
      - name: resourceids
        in: query
        description: Delete tags for resource id(s). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: resourcetype
        in: query
        description: Delete tag by resource type
        required: true
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: Delete tags matching key/value pairs. Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `deleteTags`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetagsresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetagsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetagsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetagsresponse
      x-cloudstack-command: deleteTags
      x-cloudstack-async: true
      x-cloudstack-since: 4.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTemplate:
    get:
      operationId: deleteTemplate
      summary: Deletes a Template from the system.
      description: |-
        Deletes a Template from the system. All Instances using the deleted Template will not be affected.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTemplate
          default: deleteTemplate
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Template
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: forced
        in: query
        description: Force delete a Template.
        schema:
          type: boolean
        x-cloudstack-since: 4.9+
      - name: issystem
        in: query
        description: Necessary if the template's type is system.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: zoneid
        in: query
        description: The ID of zone of the Template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetemplateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetemplateresponse
      x-cloudstack-command: deleteTemplate
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTrafficMonitor:
    get:
      operationId: deleteTrafficMonitor
      summary: Deletes an traffic monitor host.
      tags:
      - TrafficMonitor
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTrafficMonitor
          default: deleteTrafficMonitor
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the Traffic Monitor Host.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `deleteTrafficMonitor`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetrafficmonitorresponse:
                    oneOf:
                    - &id127
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id127
                        - type: array
                          items: *id127
                required:
                - deletetrafficmonitorresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetrafficmonitorresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetrafficmonitorresponse
      x-cloudstack-command: deleteTrafficMonitor
      x-cloudstack-async: false
  /deleteTrafficType:
    get:
      operationId: deleteTrafficType
      summary: Deletes traffic type of a physical network
      description: |-
        Deletes traffic type of a physical network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TrafficType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTrafficType
          default: deleteTrafficType
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Traffic type ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addTrafficType
        - listTrafficTypes
        - updateTrafficType
      responses:
        '200':
          description: Successful invocation of `deleteTrafficType`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetraffictyperesponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetraffictyperesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetraffictyperesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetraffictyperesponse
      x-cloudstack-command: deleteTrafficType
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricAddressGroup:
    get:
      operationId: deleteTungstenFabricAddressGroup
      summary: Delete Tungsten-Fabric address group
      description: |-
        Delete Tungsten-Fabric address group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricAddressGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricAddressGroup
          default: deleteTungstenFabricAddressGroup
      - $ref: '#/components/parameters/response'
      - name: addressgroupuuid
        in: query
        description: The UUID of Tungsten-Fabric address group
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricAddressGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricaddressgroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabricaddressgroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricaddressgroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabricaddressgroupresponse
      x-cloudstack-command: deleteTungstenFabricAddressGroup
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricApplicationPolicySet:
    get:
      operationId: deleteTungstenFabricApplicationPolicySet
      summary: Delete Tungsten-Fabric application policy set
      description: |-
        Delete Tungsten-Fabric application policy set

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricApplicationPolicySet
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricApplicationPolicySet
          default: deleteTungstenFabricApplicationPolicySet
      - $ref: '#/components/parameters/response'
      - name: applicationpolicysetuuid
        in: query
        description: The UUID of Tungsten-Fabric application policy set
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricApplicationPolicySet`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricapplicationpolicysetresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabricapplicationpolicysetresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricapplicationpolicysetresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabricapplicationpolicysetresponse
      x-cloudstack-command: deleteTungstenFabricApplicationPolicySet
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricFirewallPolicy:
    get:
      operationId: deleteTungstenFabricFirewallPolicy
      summary: Delete Tungsten-Fabric firewall policy
      description: |-
        Delete Tungsten-Fabric firewall policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricFirewallPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricFirewallPolicy
          default: deleteTungstenFabricFirewallPolicy
      - $ref: '#/components/parameters/response'
      - name: firewallpolicyuuid
        in: query
        description: The uuid of Tungsten-Fabric firewall policy
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricFirewallPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricfirewallpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabricfirewallpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricfirewallpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabricfirewallpolicyresponse
      x-cloudstack-command: deleteTungstenFabricFirewallPolicy
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricFirewallRule:
    get:
      operationId: deleteTungstenFabricFirewallRule
      summary: Delete Tungsten-Fabric firewall rule
      description: |-
        Delete Tungsten-Fabric firewall rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricFirewallRule
          default: deleteTungstenFabricFirewallRule
      - $ref: '#/components/parameters/response'
      - name: firewallruleuuid
        in: query
        description: The uuid of Tungsten-Fabric firewall rule
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabricfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabricfirewallruleresponse
      x-cloudstack-command: deleteTungstenFabricFirewallRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricLogicalRouter:
    get:
      operationId: deleteTungstenFabricLogicalRouter
      summary: Delete Tungsten-Fabric logical router
      description: |-
        Delete Tungsten-Fabric logical router

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricLogicalRouter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricLogicalRouter
          default: deleteTungstenFabricLogicalRouter
      - $ref: '#/components/parameters/response'
      - name: logicalrouteruuid
        in: query
        description: The uuid of Tungsten-Fabric logical router
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricLogicalRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabriclogicalrouterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabriclogicalrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabriclogicalrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabriclogicalrouterresponse
      x-cloudstack-command: deleteTungstenFabricLogicalRouter
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricPolicy:
    get:
      operationId: deleteTungstenFabricPolicy
      summary: Delete Tungsten-Fabric policy
      description: |-
        Delete Tungsten-Fabric policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricPolicy
          default: deleteTungstenFabricPolicy
      - $ref: '#/components/parameters/response'
      - name: policyuuid
        in: query
        description: The Uuid of Tungsten-Fabric tag type
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabricpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabricpolicyresponse
      x-cloudstack-command: deleteTungstenFabricPolicy
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricServiceGroup:
    get:
      operationId: deleteTungstenFabricServiceGroup
      summary: Delete Tungsten-Fabric service group
      description: |-
        Delete Tungsten-Fabric service group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricServiceGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricServiceGroup
          default: deleteTungstenFabricServiceGroup
      - $ref: '#/components/parameters/response'
      - name: servicegroupuuid
        in: query
        description: The uuid of Tungsten-Fabric service group
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricServiceGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricservicegroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabricservicegroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabricservicegroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabricservicegroupresponse
      x-cloudstack-command: deleteTungstenFabricServiceGroup
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricTag:
    get:
      operationId: deleteTungstenFabricTag
      summary: Delete Tungsten-Fabric tag
      description: |-
        Delete Tungsten-Fabric tag

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricTag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricTag
          default: deleteTungstenFabricTag
      - $ref: '#/components/parameters/response'
      - name: taguuid
        in: query
        description: The uuid of Tungsten-Fabric tag
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricTag`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabrictagresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabrictagresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabrictagresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabrictagresponse
      x-cloudstack-command: deleteTungstenFabricTag
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteTungstenFabricTagType:
    get:
      operationId: deleteTungstenFabricTagType
      summary: Delete Tungsten-Fabric tag type
      description: |-
        Delete Tungsten-Fabric tag type

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricTagType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteTungstenFabricTagType
          default: deleteTungstenFabricTagType
      - $ref: '#/components/parameters/response'
      - name: tagtypeuuid
        in: query
        description: The ID of Tungsten-Fabric tag type
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteTungstenFabricTagType`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabrictagtyperesponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletetungstenfabrictagtyperesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletetungstenfabrictagtyperesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletetungstenfabrictagtyperesponse
      x-cloudstack-command: deleteTungstenFabricTagType
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteUcsManager:
    get:
      operationId: deleteUcsManager
      summary: Delete a Ucs manager
      tags:
      - UcsManager
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteUcsManager
          default: deleteUcsManager
      - $ref: '#/components/parameters/response'
      - name: ucsmanagerid
        in: query
        description: Ucs manager ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addUcsManager
        - listUcsManagers
      responses:
        '200':
          description: Successful invocation of `deleteUcsManager`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteucsmanagerresponse:
                    oneOf:
                    - &id128
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id128
                        - type: array
                          items: *id128
                required:
                - deleteucsmanagerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteucsmanagerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteucsmanagerresponse
      x-cloudstack-command: deleteUcsManager
      x-cloudstack-async: false
  /deleteUser:
    get:
      operationId: deleteUser
      summary: Deletes a user for an account
      tags:
      - User
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteUser
          default: deleteUser
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the user to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
        - updateUser
      responses:
        '200':
          description: Successful invocation of `deleteUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteuserresponse:
                    oneOf:
                    - &id129
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id129
                        - type: array
                          items: *id129
                required:
                - deleteuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteuserresponse
      x-cloudstack-command: deleteUser
      x-cloudstack-async: false
  /deleteUserData:
    get:
      operationId: deleteUserData
      summary: Deletes a userdata
      tags:
      - UserData
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteUserData
          default: deleteUserData
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Userdata
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: account
        in: query
        description: An optional account for the userdata. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the userdata. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: projectid
        in: query
        description: An optional project for the userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteUserData`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteuserdataresponse:
                    oneOf:
                    - &id130
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id130
                        - type: array
                          items: *id130
                required:
                - deleteuserdataresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteuserdataresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteuserdataresponse
      x-cloudstack-command: deleteUserData
      x-cloudstack-async: false
      x-cloudstack-since: '4.18'
  /deleteUserFromProject:
    get:
      operationId: deleteUserFromProject
      summary: Deletes User from the project
      description: |-
        Deletes User from the project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteUserFromProject
          default: deleteUserFromProject
      - $ref: '#/components/parameters/response'
      - name: projectid
        in: query
        description: ID of the project to remove the User from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: userid
        in: query
        description: Id of the User to be removed from the project
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
        - lockUser
      responses:
        '200':
          description: Successful invocation of `deleteUserFromProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteuserfromprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deleteuserfromprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteuserfromprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteuserfromprojectresponse
      x-cloudstack-command: deleteUserFromProject
      x-cloudstack-async: true
      x-cloudstack-since: 4.15.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteUserKeys:
    get:
      operationId: deleteUserKeys
      summary: Deletes a keypair from a user
      tags:
      - UserKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteUserKeys
          default: deleteUserKeys
      - $ref: '#/components/parameters/response'
      - name: keypairid
        in: query
        description: ID of the keypair to be deleted.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listUserKeys
      responses:
        '200':
          description: Successful invocation of `deleteUserKeys`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteuserkeysresponse:
                    oneOf:
                    - &id131
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id131
                        - type: array
                          items: *id131
                required:
                - deleteuserkeysresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleteuserkeysresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deleteuserkeysresponse
      x-cloudstack-command: deleteUserKeys
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /deleteVMSchedule:
    get:
      operationId: deleteVMSchedule
      summary: Delete Instance Schedule.
      tags:
      - VMSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVMSchedule
          default: deleteVMSchedule
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: ID of Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: id
        in: query
        description: ID of Instance schedule
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: ids
        in: query
        description: IDs of Instance schedule. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `deleteVMSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevmscheduleresponse:
                    oneOf:
                    - &id132
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id132
                        - type: array
                          items: *id132
                required:
                - deletevmscheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevmscheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevmscheduleresponse
      x-cloudstack-command: deleteVMSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /deleteVMSnapshot:
    get:
      operationId: deleteVMSnapshot
      summary: Deletes an Instance Snapshot.
      description: |-
        Deletes an Instance Snapshot.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VMSnapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVMSnapshot
          default: deleteVMSnapshot
      - $ref: '#/components/parameters/response'
      - name: vmsnapshotid
        in: query
        description: The ID of the Instance Snapshot
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVMSnapshot
        - listVMSnapshot
      responses:
        '200':
          description: Successful invocation of `deleteVMSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevmsnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletevmsnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevmsnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevmsnapshotresponse
      x-cloudstack-command: deleteVMSnapshot
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteVPC:
    get:
      operationId: deleteVPC
      summary: Deletes a VPC
      description: |-
        Deletes a VPC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPC
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVPC
          default: deleteVPC
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the VPC
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `deleteVPC`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpcresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletevpcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevpcresponse
      x-cloudstack-command: deleteVPC
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteVPCOffering:
    get:
      operationId: deleteVPCOffering
      summary: Deletes VPC offering
      description: |-
        Deletes VPC offering

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPCOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVPCOffering
          default: deleteVPCOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the VPC offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneVPCOffering
        - listVPCOfferings
        - updateVPCOffering
      responses:
        '200':
          description: Successful invocation of `deleteVPCOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpcofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletevpcofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpcofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevpcofferingresponse
      x-cloudstack-command: deleteVPCOffering
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteVgpuProfile:
    get:
      operationId: deleteVgpuProfile
      summary: Deletes a vGPU profile from the system
      tags:
      - VgpuProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVgpuProfile
          default: deleteVgpuProfile
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the vGPU profile
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVgpuProfile
      responses:
        '200':
          description: Successful invocation of `deleteVgpuProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevgpuprofileresponse:
                    oneOf:
                    - &id133
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id133
                        - type: array
                          items: *id133
                required:
                - deletevgpuprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevgpuprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevgpuprofileresponse
      x-cloudstack-command: deleteVgpuProfile
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /deleteVlanIpRange:
    get:
      operationId: deleteVlanIpRange
      summary: Deletes a VLAN IP range.
      tags:
      - VlanIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVlanIpRange
          default: deleteVlanIpRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the VLAN IP range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVlanIpRange
        - dedicatePublicIpRange
        - updateVlanIpRange
      responses:
        '200':
          description: Successful invocation of `deleteVlanIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevlaniprangeresponse:
                    oneOf:
                    - &id134
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id134
                        - type: array
                          items: *id134
                required:
                - deletevlaniprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevlaniprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevlaniprangeresponse
      x-cloudstack-command: deleteVlanIpRange
      x-cloudstack-async: false
  /deleteVnfTemplate:
    get:
      operationId: deleteVnfTemplate
      summary: Deletes a VNF template from the system.
      description: |-
        Deletes a VNF template from the system. All virtual machines using the deleted template will not be affected.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VnfTemplate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVnfTemplate
          default: deleteVnfTemplate
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Template
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: forced
        in: query
        description: Force delete a Template.
        schema:
          type: boolean
        x-cloudstack-since: 4.9+
      - name: issystem
        in: query
        description: Necessary if the template's type is system.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: zoneid
        in: query
        description: The ID of zone of the Template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteVnfTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevnftemplateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletevnftemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevnftemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevnftemplateresponse
      x-cloudstack-command: deleteVnfTemplate
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteVolume:
    get:
      operationId: deleteVolume
      summary: Deletes a detached disk volume.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVolume
          default: deleteVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the disk volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      responses:
        '200':
          description: Successful invocation of `deleteVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevolumeresponse:
                    oneOf:
                    - &id135
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id135
                        - type: array
                          items: *id135
                required:
                - deletevolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevolumeresponse
      x-cloudstack-command: deleteVolume
      x-cloudstack-async: false
  /deleteVpnConnection:
    get:
      operationId: deleteVpnConnection
      summary: Delete site to site VPN connection
      description: |-
        Delete site to site VPN connection

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnConnection
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVpnConnection
          default: deleteVpnConnection
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of VPN connection
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `deleteVpnConnection`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpnconnectionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletevpnconnectionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpnconnectionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevpnconnectionresponse
      x-cloudstack-command: deleteVpnConnection
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteVpnCustomerGateway:
    get:
      operationId: deleteVpnCustomerGateway
      summary: Delete site to site VPN customer gateway
      description: |-
        Delete site to site VPN customer gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnCustomerGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVpnCustomerGateway
          default: deleteVpnCustomerGateway
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of customer gateway
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVpnCustomerGateway
        - listVpnCustomerGateways
        - updateVpnCustomerGateway
      responses:
        '200':
          description: Successful invocation of `deleteVpnCustomerGateway`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpncustomergatewayresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletevpncustomergatewayresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpncustomergatewayresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevpncustomergatewayresponse
      x-cloudstack-command: deleteVpnCustomerGateway
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteVpnGateway:
    get:
      operationId: deleteVpnGateway
      summary: Delete site to site VPN gateway
      description: |-
        Delete site to site VPN gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteVpnGateway
          default: deleteVpnGateway
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of customer gateway
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVpnGateway
      responses:
        '200':
          description: Successful invocation of `deleteVpnGateway`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpngatewayresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deletevpngatewayresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletevpngatewayresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletevpngatewayresponse
      x-cloudstack-command: deleteVpnGateway
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /deleteWebhook:
    get:
      operationId: deleteWebhook
      summary: Deletes a Webhook
      tags:
      - Webhook
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteWebhook
          default: deleteWebhook
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Webhook
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createWebhook
        - updateWebhook
      responses:
        '200':
          description: Successful invocation of `deleteWebhook`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletewebhookresponse:
                    oneOf:
                    - &id136
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id136
                        - type: array
                          items: *id136
                required:
                - deletewebhookresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletewebhookresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletewebhookresponse
      x-cloudstack-command: deleteWebhook
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /deleteWebhookDelivery:
    get:
      operationId: deleteWebhookDelivery
      summary: Deletes Webhook delivery
      tags:
      - WebhookDelivery
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteWebhookDelivery
          default: deleteWebhookDelivery
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: The end date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having end date equal to or before the specified date will be considered. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: id
        in: query
        description: The ID of the Webhook delivery
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: managementserverid
        in: query
        description: The ID of the management server
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: startdate
        in: query
        description: The start date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having start date equal to or after the specified date will be considered. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: webhookid
        in: query
        description: The ID of the Webhook
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createWebhook
        - updateWebhook
      responses:
        '200':
          description: Successful invocation of `deleteWebhookDelivery`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletewebhookdeliveryresponse:
                    oneOf:
                    - &id137
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id137
                        - type: array
                          items: *id137
                required:
                - deletewebhookdeliveryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletewebhookdeliveryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletewebhookdeliveryresponse
      x-cloudstack-command: deleteWebhookDelivery
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /deleteWebhookFilter:
    get:
      operationId: deleteWebhookFilter
      summary: Deletes Webhook filter
      tags:
      - WebhookFilter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteWebhookFilter
          default: deleteWebhookFilter
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Webhook filter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listWebhookFilters
      - name: webhookid
        in: query
        description: The ID of the Webhook
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addWebhookFilter
        - createWebhook
        - listWebhookDeliveries
        - listWebhooks
        - updateWebhook
      responses:
        '200':
          description: Successful invocation of `deleteWebhookFilter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletewebhookfilterresponse:
                    oneOf:
                    - &id138
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id138
                        - type: array
                          items: *id138
                required:
                - deletewebhookfilterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletewebhookfilterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletewebhookfilterresponse
      x-cloudstack-command: deleteWebhookFilter
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /deleteZone:
    get:
      operationId: deleteZone
      summary: Deletes a Zone.
      tags:
      - Zone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deleteZone
          default: deleteZone
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `deleteZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletezoneresponse:
                    oneOf:
                    - &id139
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id139
                        - type: array
                          items: *id139
                required:
                - deletezoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deletezoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deletezoneresponse
      x-cloudstack-command: deleteZone
      x-cloudstack-async: false
  /deployNetscalerVpx:
    get:
      operationId: deployNetscalerVpx
      summary: Creates new NS Vpx
      description: |-
        Creates new NS Vpx

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetscalerVpx
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deployNetscalerVpx
          default: deployNetscalerVpx
      - $ref: '#/components/parameters/response'
      - name: serviceofferingid
        in: query
        description: The ID of the service offering for the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: templateid
        in: query
        description: The ID of the template for the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: zoneid
        in: query
        description: Availability zone for the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: networkid
        in: query
        description: The network this ip address should be associated to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      responses:
        '200':
          description: Successful invocation of `deployNetscalerVpx`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deploynetscalervpxresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deploynetscalervpxresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deploynetscalervpxresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deploynetscalervpxresponse
      x-cloudstack-command: deployNetscalerVpx
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNetscalerLoadBalancer
      - registerNetscalerControlCenter
      x-cloudstack-jobresult-schema: '#/components/schemas/NetscalerLoadBalancer'
  /deployVirtualMachine:
    get:
      operationId: deployVirtualMachine
      summary: Creates and automatically starts  an Instance based on a service offering, disk offering, and Template.
      description: |-
        Creates and automatically starts  an Instance based on a service offering, disk offering, and Template.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deployVirtualMachine
          default: deployVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: serviceofferingid
        in: query
        description: The ID of the Service offering for the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: zoneid
        in: query
        description: availability zone for the virtual machine
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: an optional account for the virtual machine. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: affinitygroupids
        in: query
        description: comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: affinitygroupnames
        in: query
        description: comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: blankinstance
        in: query
        description: Whether to create a blank instance without storage and network
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: bootintosetup
        in: query
        description: Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)
        schema:
          type: boolean
        x-cloudstack-since: 4.15.0.0
      - name: bootmode
        in: query
        description: Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.14.0.0
      - name: boottype
        in: query
        description: Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.14.0.0
      - name: clusterid
        in: query
        description: Destination Cluster ID to deploy the Instance to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - addCluster
      - name: copyimagetags
        in: query
        description: if true the image tags (if any) will be copied to the VM, default value is false
        schema:
          type: boolean
        x-cloudstack-since: '4.13'
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
      - name: datadiskofferinglist
        in: query
        description: datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter. Map parameter. CloudStack expects it index-encoded as `datadiskofferinglist[0].key=k&datadiskofferinglist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.11'
      - name: datadisksdetails
        in: query
        description: 'Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>. Map parameter. CloudStack expects it index-encoded as `datadisksdetails[0].key=k&datadisksdetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: deploymentplanner
        in: query
        description: Deployment planner to use for vm allocation. Available to ROOT admin only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: details
        in: query
        description: used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.3'
      - name: dhcpoptionsnetworklist
        in: query
        description: 'DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com. Map parameter. CloudStack expects it index-encoded as `dhcpoptionsnetworklist[0].key=k&dhcpoptionsnetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: diskofferingid
        in: query
        description: the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: displayname
        in: query
        description: an optional user generated name for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: displayvm
        in: query
        description: an optional field, whether to the display the vm to the end user or not.
        schema:
          type: boolean
        x-cloudstack-since: '4.2'
      - name: domainid
        in: query
        description: an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: dynamicscalingenabled
        in: query
        description: true if virtual machine needs to be dynamically scalable
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: extraconfig
        in: query
        description: an optional URL encoded string that can be passed to the virtual machine upon successful deployment
        schema:
          type: string
          maxLength: 5120
        x-cloudstack-since: '4.12'
      - name: group
        in: query
        description: an optional group for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: hostid
        in: query
        description: destination Host ID to deploy the VM to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: hypervisor
        in: query
        description: the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call
        schema:
          type: string
          maxLength: 255
      - name: iodriverpolicy
        in: query
        description: Controls specific policies on IO
        schema:
          type: string
          maxLength: 255
      - name: iothreadsenabled
        in: query
        description: IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.
        schema:
          type: boolean
      - name: ip6address
        in: query
        description: the ipv6 address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: ipaddress
        in: query
        description: the ip address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: iptonetworklist
        in: query
        description: 'ip to network mapping. Can''t be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid. Map parameter. CloudStack expects it index-encoded as `iptonetworklist[0].key=k&iptonetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: keyboard
        in: query
        description: an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us
        schema:
          type: string
          maxLength: 255
      - name: keypair
        in: query
        description: name of the ssh key pair used to login to the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: keypairs
        in: query
        description: names of the ssh key pairs used to login to the virtual machine. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.17'
      - name: leaseduration
        in: query
        description: Number of days instance is leased for.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.21.0
      - name: leaseexpiryaction
        in: query
        description: Lease expiry action, valid values are STOP and DESTROY
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: macaddress
        in: query
        description: the mac address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: host name for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: networkids
        in: query
        description: list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: nicmultiqueuenumber
        in: query
        description: The number of queues for multiqueue NICs.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.18'
      - name: nicnetworklist
        in: query
        description: 'VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid. Map parameter. CloudStack expects it index-encoded as `nicnetworklist[0].key=k&nicnetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.15'
      - name: nicpackedvirtqueuesenabled
        in: query
        description: Enable packed virtqueues or not.
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: overridediskofferingid
        in: query
        description: the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
      - name: password
        in: query
        description: The password of the virtual machine. If null, a random password will be generated for the VM.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0.0
      - name: podid
        in: query
        description: Destination Pod ID to deploy the Instance to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: projectid
        in: query
        description: Deploy vm for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: properties
        in: query
        description: used to specify the vApp properties. Map parameter. CloudStack expects it index-encoded as `properties[0].key=k&properties[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.15'
      - name: rootdiskkmskeyid
        in: query
        description: ID of the KMS Key to use for root disk encryption
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createKMSKey
        - updateKMSKey
      - name: rootdisksize
        in: query
        description: Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.4'
      - name: securitygroupids
        in: query
        description: comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: securitygroupnames
        in: query
        description: comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: size
        in: query
        description: the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId
        schema:
          type: integer
          format: int64
      - name: snapshotid
        in: query
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.21'
        x-cloudstack-related:
        - copySnapshot
        - listSnapshots
      - name: startvm
        in: query
        description: true if start vm after creating; defaulted to true if not specified
        schema:
          type: boolean
      - name: templateid
        in: query
        description: The ID of the Template for the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: userdata
        in: query
        description: an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value
        schema:
          type: string
          maxLength: 1048576
      - name: userdatadetails
        in: query
        description: used to specify the parameters values for the variables in userdata. Map parameter. CloudStack expects it index-encoded as `userdatadetails[0].key=k&userdatadetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.18'
      - name: userdataid
        in: query
        description: the ID of the Userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.18'
      - name: volumeid
        in: query
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.21'
        x-cloudstack-related:
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      responses:
        '200':
          description: Successful invocation of `deployVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deployvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deployvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deployvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deployvirtualmachineresponse
      x-cloudstack-command: deployVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /deployVnfAppliance:
    get:
      operationId: deployVnfAppliance
      summary: Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.
      description: |-
        Creates and automatically starts a VNF appliance based on a service offering, disk offering, and template.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VnfAppliance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: deployVnfAppliance
          default: deployVnfAppliance
      - $ref: '#/components/parameters/response'
      - name: serviceofferingid
        in: query
        description: The ID of the Service offering for the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: zoneid
        in: query
        description: availability zone for the virtual machine
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: an optional account for the virtual machine. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: affinitygroupids
        in: query
        description: comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: affinitygroupnames
        in: query
        description: comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: bootintosetup
        in: query
        description: Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)
        schema:
          type: boolean
        x-cloudstack-since: 4.15.0.0
      - name: bootmode
        in: query
        description: Boot Mode [Legacy] or [Secure] Applicable when Boot Type Selected is UEFI, otherwise Legacy only for BIOS. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.14.0.0
      - name: boottype
        in: query
        description: Guest VM Boot option either custom[UEFI] or default boot [BIOS]. Not applicable with VMware if the template is marked as deploy-as-is, as we honour what is defined in the template.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.14.0.0
      - name: copyimagetags
        in: query
        description: if true the image tags (if any) will be copied to the VM, default value is false
        schema:
          type: boolean
        x-cloudstack-since: '4.13'
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
      - name: datadiskofferinglist
        in: query
        description: datadisk template to disk-offering mapping; an optional parameter used to create additional data disks from datadisk templates; can't be specified with diskOfferingId parameter. Map parameter. CloudStack expects it index-encoded as `datadiskofferinglist[0].key=k&datadiskofferinglist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.11'
      - name: datadisksdetails
        in: query
        description: 'Disk offering details for creating multiple data volumes. Mutually exclusive with diskOfferingId. Example: datadisksdetails[0].diskofferingid=a2a73a84-19db-4852-8930-dfddef053341&datadisksdetails[0].size=10&datadisksdetails[0].miniops=100&datadisksdetails[0].maxiops=200&datadisksdetails[0].kmskeyid=<uuid>. Map parameter. CloudStack expects it index-encoded as `datadisksdetails[0].key=k&datadisksdetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: deploymentplanner
        in: query
        description: Deployment planner to use for vm allocation. Available to ROOT admin only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: details
        in: query
        description: used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.3'
      - name: dhcpoptionsnetworklist
        in: query
        description: 'DHCP options which are passed to the VM on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com. Map parameter. CloudStack expects it index-encoded as `dhcpoptionsnetworklist[0].key=k&dhcpoptionsnetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: diskofferingid
        in: query
        description: the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: displayname
        in: query
        description: an optional user generated name for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: displayvm
        in: query
        description: an optional field, whether to the display the vm to the end user or not.
        schema:
          type: boolean
        x-cloudstack-since: '4.2'
      - name: domainid
        in: query
        description: an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used. If account is NOT provided then virtual machine will be assigned to the caller account and domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: dynamicscalingenabled
        in: query
        description: true if virtual machine needs to be dynamically scalable
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: extraconfig
        in: query
        description: an optional URL encoded string that can be passed to the virtual machine upon successful deployment
        schema:
          type: string
          maxLength: 5120
        x-cloudstack-since: '4.12'
      - name: group
        in: query
        description: an optional group for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: hostid
        in: query
        description: destination Host ID to deploy the VM to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: hypervisor
        in: query
        description: the hypervisor on which to deploy the virtual machine. The parameter is required and respected only when hypervisor info is not set on the ISO/Template passed to the call
        schema:
          type: string
          maxLength: 255
      - name: iodriverpolicy
        in: query
        description: Controls specific policies on IO
        schema:
          type: string
          maxLength: 255
      - name: iothreadsenabled
        in: query
        description: IOThreads are dedicated event loop threads for supported disk devices to perform block I/O requests in order to improve scalability especially on an SMP host/guest with many LUNs.
        schema:
          type: boolean
      - name: ip6address
        in: query
        description: the ipv6 address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: ipaddress
        in: query
        description: the ip address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: iptonetworklist
        in: query
        description: 'ip to network mapping. Can''t be specified with networkIds parameter. Example: iptonetworklist[0].ip=10.10.10.11&iptonetworklist[0].ipv6=fc00:1234:5678::abcd&iptonetworklist[0].networkid=uuid&iptonetworklist[0].mac=aa:bb:cc:dd:ee::ff - requests to use ip 10.10.10.11 in network id=uuid. Map parameter. CloudStack expects it index-encoded as `iptonetworklist[0].key=k&iptonetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: keyboard
        in: query
        description: an optional keyboard device type for the virtual machine. valid value can be one of de,de-ch,es,es-latam,fi,fr,fr-be,fr-ch,is,it,jp,nl-be,no,pt,uk,us
        schema:
          type: string
          maxLength: 255
      - name: keypair
        in: query
        description: name of the ssh key pair used to login to the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: keypairs
        in: query
        description: names of the ssh key pairs used to login to the virtual machine. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.17'
      - name: leaseduration
        in: query
        description: Number of days instance is leased for.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.21.0
      - name: leaseexpiryaction
        in: query
        description: Lease expiry action, valid values are STOP and DESTROY
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: macaddress
        in: query
        description: the mac address for default vm's network
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: host name for the virtual machine
        schema:
          type: string
          maxLength: 255
      - name: networkids
        in: query
        description: list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: nicmultiqueuenumber
        in: query
        description: The number of queues for multiqueue NICs.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.18'
      - name: nicnetworklist
        in: query
        description: 'VMware only: used to specify network mapping of a vApp VMware template registered "as-is". Example nicnetworklist[0].ip=Nic-101&nicnetworklist[0].network=uuid. Map parameter. CloudStack expects it index-encoded as `nicnetworklist[0].key=k&nicnetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.15'
      - name: nicpackedvirtqueuesenabled
        in: query
        description: Enable packed virtqueues or not.
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: overridediskofferingid
        in: query
        description: the ID of the disk offering for the virtual machine to be used for root volume instead of the disk offering mapped in service offering.In case of virtual machine deploying from ISO, then the diskofferingid specified for root volume is ignored and uses this override disk offering id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
      - name: password
        in: query
        description: The password of the virtual machine. If null, a random password will be generated for the VM.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0.0
      - name: projectid
        in: query
        description: Deploy vm for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: properties
        in: query
        description: used to specify the vApp properties. Map parameter. CloudStack expects it index-encoded as `properties[0].key=k&properties[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.15'
      - name: rootdiskkmskeyid
        in: query
        description: ID of the KMS Key to use for root disk encryption
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createKMSKey
        - updateKMSKey
      - name: rootdisksize
        in: query
        description: Optional field to resize root disk on deploy. Value is in GB. Only applies to template-based deployments. Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.4'
      - name: securitygroupids
        in: query
        description: comma separated list of security groups id that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - updateSecurityGroup
      - name: securitygroupnames
        in: query
        description: comma separated list of security groups names that going to be applied to the virtual machine. Should be passed only when vm is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - updateSecurityGroup
      - name: size
        in: query
        description: the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId
        schema:
          type: integer
          format: int64
      - name: snapshotid
        in: query
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.21'
        x-cloudstack-related:
        - archiveSnapshot
        - copySnapshot
        - createSnapshotFromVMSnapshot
        - listSnapshots
      - name: startvm
        in: query
        description: true if start vm after creating; defaulted to true if not specified
        schema:
          type: boolean
      - name: templateid
        in: query
        description: The ID of the Template for the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: userdata
        in: query
        description: an optional binary data that can be sent to the virtual machine upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value
        schema:
          type: string
          maxLength: 1048576
      - name: userdatadetails
        in: query
        description: used to specify the parameters values for the variables in userdata. Map parameter. CloudStack expects it index-encoded as `userdatadetails[0].key=k&userdatadetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.18'
      - name: userdataid
        in: query
        description: the ID of the Userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.18'
        x-cloudstack-related:
        - listCniConfiguration
      - name: vnfcidrlist
        in: query
        description: the CIDR list to forward traffic from to the VNF management interface. Multiple entries must be separated by a single comma character (,). The default value is 0.0.0.0/0. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: vnfconfiguremanagement
        in: query
        description: False by default, security group or network rules (source nat and firewall rules) will be configured for VNF management interfaces. True otherwise. Network rules are configured if management network is an isolated network or shared network with security groups.
        schema:
          type: boolean
      - name: volumeid
        in: query
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.21'
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      responses:
        '200':
          description: Successful invocation of `deployVnfAppliance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deployvnfapplianceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - deployvnfapplianceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  deployvnfapplianceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - deployvnfapplianceresponse
      x-cloudstack-command: deployVnfAppliance
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /destroyRouter:
    get:
      operationId: destroyRouter
      summary: Destroys a router.
      description: |-
        Destroys a router.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Router
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: destroyRouter
          default: destroyRouter
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the router
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - destroyRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - rebootRouter
        - stopInternalLoadBalancerVM
        - stopNetScalerVpx
        - stopRouter
      responses:
        '200':
          description: Successful invocation of `destroyRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroyrouterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - destroyrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroyrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - destroyrouterresponse
      x-cloudstack-command: destroyRouter
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForRouter
      - listInternalLoadBalancerVMs
      - listRouters
      - rebootRouter
      - stopInternalLoadBalancerVM
      - stopNetScalerVpx
      - stopRouter
      x-cloudstack-jobresult-schema: '#/components/schemas/Router'
  /destroySharedFileSystem:
    get:
      operationId: destroySharedFileSystem
      summary: Destroy a Shared FileSystem by id
      description: |-
        Destroy a Shared FileSystem by id

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: destroySharedFileSystem
          default: destroySharedFileSystem
      - $ref: '#/components/parameters/response'
      - name: expunge
        in: query
        description: If true is passed, the shared filesystem is expunged immediately. False by default.
        schema:
          type: boolean
      - name: forced
        in: query
        description: If true is passed, the shared filesystem can be destroyed without stopping it first.
        schema:
          type: boolean
      - name: id
        in: query
        description: the ID of the shared filesystem to delete
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
        - changeSharedFileSystemServiceOffering
        - listSharedFileSystems
        - startSharedFileSystem
        - stopSharedFileSystem
      responses:
        '200':
          description: Successful invocation of `destroySharedFileSystem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroysharedfilesystemresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - destroysharedfilesystemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroysharedfilesystemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - destroysharedfilesystemresponse
      x-cloudstack-command: destroySharedFileSystem
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /destroySystemVm:
    get:
      operationId: destroySystemVm
      summary: Destroys a System VM.
      description: |-
        Destroys a System VM.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: destroySystemVm
          default: destroySystemVm
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the System VM
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForSystemVm
        - destroySystemVm
        - listSystemVms
        - migrateSystemVm
        - scaleSystemVm
        - startSystemVm
        - stopSystemVm
      responses:
        '200':
          description: Successful invocation of `destroySystemVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroysystemvmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - destroysystemvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroysystemvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - destroysystemvmresponse
      x-cloudstack-command: destroySystemVm
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForSystemVm
      - listSystemVms
      - migrateSystemVm
      - scaleSystemVm
      - startSystemVm
      - stopSystemVm
      x-cloudstack-jobresult-schema: '#/components/schemas/SystemVm'
  /destroyVirtualMachine:
    get:
      operationId: destroyVirtualMachine
      summary: Destroys  an Instance.
      description: |-
        Destroys  an Instance. Once destroyed, only the administrator can recover it.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: destroyVirtualMachine
          default: destroyVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: expunge
        in: query
        description: If true is passed, the Instance is expunged immediately. False by default.
        schema:
          type: boolean
        x-cloudstack-since: 4.2.1
      - name: forced
        in: query
        description: Force destroy the Instance
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: volumeids
        in: query
        description: Comma separated list of UUIDs for volumes that will be deleted. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.12.0
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      responses:
        '200':
          description: Successful invocation of `destroyVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroyvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - destroyvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroyvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - destroyvirtualmachineresponse
      x-cloudstack-command: destroyVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /destroyVolume:
    get:
      operationId: destroyVolume
      summary: Destroys a Volume.
      description: |-
        Destroys a Volume.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: destroyVolume
          default: destroyVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: expunge
        in: query
        description: If true is passed, the volume is expunged immediately. False by default.
        schema:
          type: boolean
        x-cloudstack-since: 4.6.0
      responses:
        '200':
          description: Successful invocation of `destroyVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroyvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - destroyvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  destroyvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - destroyvolumeresponse
      x-cloudstack-command: destroyVolume
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-related:
      - assignVolume
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /detachIso:
    get:
      operationId: detachIso
      summary: Detaches any ISO file (if any) currently attached to  an Instance.
      description: |-
        Detaches any ISO file (if any) currently attached to  an Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Iso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: detachIso
          default: detachIso
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: The ID of the  Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: forced
        in: query
        description: 'If true, ejects the ISO before detaching on VMware. Default: false'
        schema:
          type: boolean
        x-cloudstack-since: 4.15.1
      - name: id
        in: query
        description: The ID of the ISO to detach. Required when the Instance has more than one ISO attached.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      responses:
        '200':
          description: Successful invocation of `detachIso`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detachisoresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - detachisoresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detachisoresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - detachisoresponse
      x-cloudstack-command: detachIso
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /detachVolume:
    get:
      operationId: detachVolume
      summary: Detaches a disk volume from  an Instance.
      description: |-
        Detaches a disk volume from  an Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: detachVolume
          default: detachVolume
      - $ref: '#/components/parameters/response'
      - name: deviceid
        in: query
        description: The device ID on the Instance where volume is detached from
        schema:
          type: integer
          format: int64
      - name: id
        in: query
        description: The ID of the disk volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: virtualmachineid
        in: query
        description: The ID of the Instance where the volume is detached from
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `detachVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detachvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - detachvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  detachvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - detachvolumeresponse
      x-cloudstack-command: detachVolume
      x-cloudstack-async: true
      x-cloudstack-related:
      - assignVolume
      - attachVolume
      - changeOfferingForVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /disableAccount:
    get:
      operationId: disableAccount
      summary: Disables an account
      description: |-
        Disables an account

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableAccount
          default: disableAccount
      - $ref: '#/components/parameters/response'
      - name: lock
        in: query
        description: If true, only lock the Account; else disable the Account
        required: true
        schema:
          type: boolean
      - name: account
        in: query
        description: Disables specified Account.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Disables specified Account in this domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: Account id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
      responses:
        '200':
          description: Successful invocation of `disableAccount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableaccountresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disableaccountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableaccountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disableaccountresponse
      x-cloudstack-command: disableAccount
      x-cloudstack-async: true
      x-cloudstack-related:
      - enableAccount
      - listAccounts
      x-cloudstack-jobresult-schema: '#/components/schemas/Account'
  /disableAutoScaleVmGroup:
    get:
      operationId: disableAutoScaleVmGroup
      summary: Disables an AutoScale Instance Group
      description: |-
        Disables an AutoScale Instance Group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScaleVmGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableAutoScaleVmGroup
          default: disableAutoScaleVmGroup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the autoscale group
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAutoScaleVmGroup
        - enableAutoScaleVmGroup
        - listAutoScaleVmGroups
        - updateAutoScaleVmGroup
      responses:
        '200':
          description: Successful invocation of `disableAutoScaleVmGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableautoscalevmgroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disableautoscalevmgroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableautoscalevmgroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disableautoscalevmgroupresponse
      x-cloudstack-command: disableAutoScaleVmGroup
      x-cloudstack-async: true
      x-cloudstack-related:
      - enableAutoScaleVmGroup
      - listAutoScaleVmGroups
      - updateAutoScaleVmGroup
      x-cloudstack-jobresult-schema: '#/components/schemas/AutoScaleVmGroup'
  /disableCiscoNexusVSM:
    get:
      operationId: disableCiscoNexusVSM
      summary: Disable a Cisco Nexus VSM device
      description: |-
        Disable a Cisco Nexus VSM device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - CiscoNexusVSM
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableCiscoNexusVSM
          default: disableCiscoNexusVSM
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the Cisco Nexus 1000v VSM device to be deleted
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableCiscoNexusVSM
        - listCiscoNexusVSMs
      responses:
        '200':
          description: Successful invocation of `disableCiscoNexusVSM`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablecisconexusvsmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disablecisconexusvsmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablecisconexusvsmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disablecisconexusvsmresponse
      x-cloudstack-command: disableCiscoNexusVSM
      x-cloudstack-async: true
      x-cloudstack-related:
      - listCiscoNexusVSMs
      x-cloudstack-jobresult-schema: '#/components/schemas/CiscoNexusVSM'
  /disableHAForCluster:
    get:
      operationId: disableHAForCluster
      summary: Disables HA cluster-wide
      description: |-
        Disables HA cluster-wide

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableHAForCluster
          default: disableHAForCluster
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: ID of the cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      responses:
        '200':
          description: Successful invocation of `disableHAForCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablehaforclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disablehaforclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablehaforclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disablehaforclusterresponse
      x-cloudstack-command: disableHAForCluster
      x-cloudstack-async: true
      x-cloudstack-since: '4.11'
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /disableHAForHost:
    get:
      operationId: disableHAForHost
      summary: Disables HA for a host
      description: |-
        Disables HA for a host

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DisableHAForHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableHAForHost
          default: disableHAForHost
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `disableHAForHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablehaforhostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disablehaforhostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablehaforhostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disablehaforhostresponse
      x-cloudstack-command: disableHAForHost
      x-cloudstack-async: true
      x-cloudstack-since: '4.11'
      x-cloudstack-jobresult-schema: '#/components/schemas/HAForHost'
  /disableHAForZone:
    get:
      operationId: disableHAForZone
      summary: Disables HA for a zone
      description: |-
        Disables HA for a zone

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DisableHAForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableHAForZone
          default: disableHAForZone
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: ID of the zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `disableHAForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablehaforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disablehaforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablehaforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disablehaforzoneresponse
      x-cloudstack-command: disableHAForZone
      x-cloudstack-async: true
      x-cloudstack-since: '4.11'
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /disableOutOfBandManagementForCluster:
    get:
      operationId: disableOutOfBandManagementForCluster
      summary: Disables out-of-band management for a cluster
      description: |-
        Disables out-of-band management for a cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableOutOfBandManagementForCluster
          default: disableOutOfBandManagementForCluster
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: The ID of the cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      responses:
        '200':
          description: Successful invocation of `disableOutOfBandManagementForCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableoutofbandmanagementforclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disableoutofbandmanagementforclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableoutofbandmanagementforclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disableoutofbandmanagementforclusterresponse
      x-cloudstack-command: disableOutOfBandManagementForCluster
      x-cloudstack-async: true
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - changeOutOfBandManagementPassword
      - configureOutOfBandManagement
      - enableOutOfBandManagementForHost
      x-cloudstack-jobresult-schema: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
  /disableOutOfBandManagementForHost:
    get:
      operationId: disableOutOfBandManagementForHost
      summary: Disables out-of-band management for a host
      description: |-
        Disables out-of-band management for a host

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DisableOutOfBandManagementForHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableOutOfBandManagementForHost
          default: disableOutOfBandManagementForHost
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: The ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - cancelHostAsDegraded
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `disableOutOfBandManagementForHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableoutofbandmanagementforhostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disableoutofbandmanagementforhostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableoutofbandmanagementforhostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disableoutofbandmanagementforhostresponse
      x-cloudstack-command: disableOutOfBandManagementForHost
      x-cloudstack-async: true
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - changeOutOfBandManagementPassword
      - configureOutOfBandManagement
      - disableOutOfBandManagementForCluster
      - enableOutOfBandManagementForHost
      x-cloudstack-jobresult-schema: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
  /disableOutOfBandManagementForZone:
    get:
      operationId: disableOutOfBandManagementForZone
      summary: Disables out-of-band management for a zone
      description: |-
        Disables out-of-band management for a zone

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DisableOutOfBandManagementForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableOutOfBandManagementForZone
          default: disableOutOfBandManagementForZone
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The ID of the zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `disableOutOfBandManagementForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableoutofbandmanagementforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disableoutofbandmanagementforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableoutofbandmanagementforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disableoutofbandmanagementforzoneresponse
      x-cloudstack-command: disableOutOfBandManagementForZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - changeOutOfBandManagementPassword
      - configureOutOfBandManagement
      - disableOutOfBandManagementForCluster
      - disableOutOfBandManagementForHost
      - enableOutOfBandManagementForCluster
      - enableOutOfBandManagementForHost
      - enableOutOfBandManagementForZone
      - issueOutOfBandManagementPowerAction
      x-cloudstack-jobresult-schema: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
  /disableRole:
    get:
      operationId: disableRole
      summary: Disables a role
      tags:
      - DisableRole
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableRole
          default: disableRole
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - listRoles
        - updateRole
      responses:
        '200':
          description: Successful invocation of `disableRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableroleresponse:
                    oneOf:
                    - &id140
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id140
                        - type: array
                          items: *id140
                required:
                - disableroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disableroleresponse
      x-cloudstack-command: disableRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /disableStaticNat:
    get:
      operationId: disableStaticNat
      summary: Disables static rule for given IP address
      description: |-
        Disables static rule for given IP address

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DisableStaticNat
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableStaticNat
          default: disableStaticNat
      - $ref: '#/components/parameters/response'
      - name: ipaddressid
        in: query
        description: The public IP address ID for which static NAT feature is being disabled
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      responses:
        '200':
          description: Successful invocation of `disableStaticNat`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablestaticnatresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disablestaticnatresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disablestaticnatresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disablestaticnatresponse
      x-cloudstack-command: disableStaticNat
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /disableUser:
    get:
      operationId: disableUser
      summary: Disables a user account
      description: |-
        Disables a user account

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DisableUser
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disableUser
          default: disableUser
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Disables user by user ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
      responses:
        '200':
          description: Successful invocation of `disableUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableuserresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disableuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disableuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disableuserresponse
      x-cloudstack-command: disableUser
      x-cloudstack-async: true
      x-cloudstack-related:
      - getUser
      x-cloudstack-jobresult-schema: '#/components/schemas/User2'
  /disassociateDnsZoneFromNetwork:
    get:
      operationId: disassociateDnsZoneFromNetwork
      summary: Removes the association between a DNS Zone and a Network
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disassociateDnsZoneFromNetwork
          default: disassociateDnsZoneFromNetwork
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: The ID of the Network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      responses:
        '200':
          description: Successful invocation of `disassociateDnsZoneFromNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disassociatednszonefromnetworkresponse:
                    oneOf:
                    - &id141
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id141
                        - type: array
                          items: *id141
                required:
                - disassociatednszonefromnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disassociatednszonefromnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disassociatednszonefromnetworkresponse
      x-cloudstack-command: disassociateDnsZoneFromNetwork
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /disassociateIpAddress:
    get:
      operationId: disassociateIpAddress
      summary: Disassociates an IP address from the Account.
      description: |-
        Disassociates an IP address from the Account.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - IpAddress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: disassociateIpAddress
          default: disassociateIpAddress
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
      - name: ipaddress
        in: query
        description: IP Address to be disassociated. Mutually exclusive with the id parameter
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      responses:
        '200':
          description: Successful invocation of `disassociateIpAddress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disassociateipaddressresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - disassociateipaddressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  disassociateipaddressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - disassociateipaddressresponse
      x-cloudstack-command: disassociateIpAddress
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /discoverGpuDevices:
    get:
      operationId: discoverGpuDevices
      summary: Discovers available GPU devices on a host
      tags:
      - GpuDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: discoverGpuDevices
          default: discoverGpuDevices
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `discoverGpuDevices`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  discovergpudevicesresponse:
                    oneOf:
                    - &id142
                      $ref: '#/components/schemas/GpuDevice'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id142
                        - type: array
                          items: *id142
                required:
                - discovergpudevicesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  discovergpudevicesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - discovergpudevicesresponse
      x-cloudstack-command: discoverGpuDevices
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - listGpuDevices
  /downloadImageStoreObject:
    get:
      operationId: downloadImageStoreObject
      summary: Download object at a specified path on an image store.
      description: |-
        Download object at a specified path on an image store.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ImageStoreObject
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: downloadImageStoreObject
          default: downloadImageStoreObject
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: id of the image store
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listSwifts
      - name: path
        in: query
        description: path to download on image store
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `downloadImageStoreObject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloadimagestoreobjectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - downloadimagestoreobjectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloadimagestoreobjectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - downloadimagestoreobjectresponse
      x-cloudstack-command: downloadImageStoreObject
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - extractSnapshot
      - extractTemplate
      x-cloudstack-jobresult-schema: '#/components/schemas/DownloadImageStoreObjectResult'
  /downloadValidationScreenshot:
    get:
      operationId: downloadValidationScreenshot
      summary: Download validation screenshot of given backup.
      description: |-
        Download validation screenshot of given backup.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ValidationScreenshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: downloadValidationScreenshot
          default: downloadValidationScreenshot
      - $ref: '#/components/parameters/response'
      - name: backupid
        in: query
        description: ID of the backup.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `downloadValidationScreenshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloadvalidationscreenshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - downloadvalidationscreenshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  downloadvalidationscreenshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - downloadvalidationscreenshotresponse
      x-cloudstack-command: downloadValidationScreenshot
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - downloadImageStoreObject
      - extractSnapshot
      - extractTemplate
      x-cloudstack-jobresult-schema: '#/components/schemas/DownloadImageStoreObjectResult'
  /enableAccount:
    get:
      operationId: enableAccount
      summary: Enables an account
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableAccount
          default: enableAccount
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Enables specified Account.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Enables specified Account in this domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: Account id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - enableAccount
        - listAccounts
      responses:
        '200':
          description: Successful invocation of `enableAccount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableaccountresponse:
                    oneOf:
                    - &id143
                      $ref: '#/components/schemas/Account'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id143
                        - type: array
                          items: *id143
                required:
                - enableaccountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableaccountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enableaccountresponse
      x-cloudstack-command: enableAccount
      x-cloudstack-async: false
      x-cloudstack-related:
      - listAccounts
  /enableAutoScaleVmGroup:
    get:
      operationId: enableAutoScaleVmGroup
      summary: Enables an AutoScale Instance Group
      description: |-
        Enables an AutoScale Instance Group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScaleVmGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableAutoScaleVmGroup
          default: enableAutoScaleVmGroup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the autoscale group
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - enableAutoScaleVmGroup
      responses:
        '200':
          description: Successful invocation of `enableAutoScaleVmGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableautoscalevmgroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enableautoscalevmgroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableautoscalevmgroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enableautoscalevmgroupresponse
      x-cloudstack-command: enableAutoScaleVmGroup
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/AutoScaleVmGroup'
  /enableCiscoNexusVSM:
    get:
      operationId: enableCiscoNexusVSM
      summary: Enable a Cisco Nexus VSM device
      description: |-
        Enable a Cisco Nexus VSM device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - CiscoNexusVSM
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableCiscoNexusVSM
          default: enableCiscoNexusVSM
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the Cisco Nexus 1000v VSM device to be enabled
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableCiscoNexusVSM
        - enableCiscoNexusVSM
        - listCiscoNexusVSMs
      responses:
        '200':
          description: Successful invocation of `enableCiscoNexusVSM`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablecisconexusvsmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enablecisconexusvsmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablecisconexusvsmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enablecisconexusvsmresponse
      x-cloudstack-command: enableCiscoNexusVSM
      x-cloudstack-async: true
      x-cloudstack-related:
      - disableCiscoNexusVSM
      - listCiscoNexusVSMs
      x-cloudstack-jobresult-schema: '#/components/schemas/CiscoNexusVSM'
  /enableHAForCluster:
    get:
      operationId: enableHAForCluster
      summary: Enables HA cluster-wide
      description: |-
        Enables HA cluster-wide

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableHAForCluster
          default: enableHAForCluster
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: ID of the cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      responses:
        '200':
          description: Successful invocation of `enableHAForCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablehaforclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enablehaforclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablehaforclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enablehaforclusterresponse
      x-cloudstack-command: enableHAForCluster
      x-cloudstack-async: true
      x-cloudstack-since: '4.11'
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /enableHAForHost:
    get:
      operationId: enableHAForHost
      summary: Enables HA for a host
      description: |-
        Enables HA for a host

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - HAForHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableHAForHost
          default: enableHAForHost
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `enableHAForHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablehaforhostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enablehaforhostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablehaforhostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enablehaforhostresponse
      x-cloudstack-command: enableHAForHost
      x-cloudstack-async: true
      x-cloudstack-since: '4.11'
      x-cloudstack-related:
      - disableHAForHost
      x-cloudstack-jobresult-schema: '#/components/schemas/HAForHost'
  /enableHAForZone:
    get:
      operationId: enableHAForZone
      summary: Enables HA for a zone
      description: |-
        Enables HA for a zone

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - HAForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableHAForZone
          default: enableHAForZone
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: ID of the zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `enableHAForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablehaforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enablehaforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablehaforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enablehaforzoneresponse
      x-cloudstack-command: enableHAForZone
      x-cloudstack-async: true
      x-cloudstack-since: '4.11'
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /enableOutOfBandManagementForCluster:
    get:
      operationId: enableOutOfBandManagementForCluster
      summary: Enables out-of-band management for a cluster
      description: |-
        Enables out-of-band management for a cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableOutOfBandManagementForCluster
          default: enableOutOfBandManagementForCluster
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: The ID of the cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      responses:
        '200':
          description: Successful invocation of `enableOutOfBandManagementForCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableoutofbandmanagementforclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enableoutofbandmanagementforclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableoutofbandmanagementforclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enableoutofbandmanagementforclusterresponse
      x-cloudstack-command: enableOutOfBandManagementForCluster
      x-cloudstack-async: true
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - changeOutOfBandManagementPassword
      - configureOutOfBandManagement
      - disableOutOfBandManagementForCluster
      - disableOutOfBandManagementForHost
      - enableOutOfBandManagementForHost
      x-cloudstack-jobresult-schema: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
  /enableOutOfBandManagementForHost:
    get:
      operationId: enableOutOfBandManagementForHost
      summary: Enables out-of-band management for a host
      description: |-
        Enables out-of-band management for a host

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - OutOfBandManagementForHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableOutOfBandManagementForHost
          default: enableOutOfBandManagementForHost
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: The ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `enableOutOfBandManagementForHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableoutofbandmanagementforhostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enableoutofbandmanagementforhostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableoutofbandmanagementforhostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enableoutofbandmanagementforhostresponse
      x-cloudstack-command: enableOutOfBandManagementForHost
      x-cloudstack-async: true
      x-cloudstack-since: 4.9.0
      x-cloudstack-jobresult-schema: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
  /enableOutOfBandManagementForZone:
    get:
      operationId: enableOutOfBandManagementForZone
      summary: Enables out-of-band management for a zone
      description: |-
        Enables out-of-band management for a zone

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - OutOfBandManagementForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableOutOfBandManagementForZone
          default: enableOutOfBandManagementForZone
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The ID of the zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `enableOutOfBandManagementForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableoutofbandmanagementforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enableoutofbandmanagementforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableoutofbandmanagementforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enableoutofbandmanagementforzoneresponse
      x-cloudstack-command: enableOutOfBandManagementForZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - changeOutOfBandManagementPassword
      - configureOutOfBandManagement
      - disableOutOfBandManagementForCluster
      - disableOutOfBandManagementForHost
      - enableOutOfBandManagementForCluster
      - enableOutOfBandManagementForHost
      - issueOutOfBandManagementPowerAction
      x-cloudstack-jobresult-schema: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
  /enableRole:
    get:
      operationId: enableRole
      summary: Enables a role
      tags:
      - Role
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableRole
          default: enableRole
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - importRole
        - listRoles
        - updateRole
      responses:
        '200':
          description: Successful invocation of `enableRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableroleresponse:
                    oneOf:
                    - &id144
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id144
                        - type: array
                          items: *id144
                required:
                - enableroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enableroleresponse
      x-cloudstack-command: enableRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /enableStaticNat:
    get:
      operationId: enableStaticNat
      summary: Enables static NAT for given IP address
      tags:
      - StaticNat
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableStaticNat
          default: enableStaticNat
      - $ref: '#/components/parameters/response'
      - name: ipaddressid
        in: query
        description: The public IP address ID for which static NAT feature is being enabled
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - updateIpAddress
      - name: virtualmachineid
        in: query
        description: The ID of the Instance for enabling static NAT feature
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: networkid
        in: query
        description: The Network of the Instance the static NAT will be enabled for. Required when public IP address is not associated with any guest Network yet (VPC case)
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: vmguestip
        in: query
        description: VM guest NIC secondary IP address for the port forwarding rule
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `enableStaticNat`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablestaticnatresponse:
                    oneOf:
                    - &id145
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id145
                        - type: array
                          items: *id145
                required:
                - enablestaticnatresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablestaticnatresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enablestaticnatresponse
      x-cloudstack-command: enableStaticNat
      x-cloudstack-async: false
  /enableStorageMaintenance:
    get:
      operationId: enableStorageMaintenance
      summary: Puts storage pool into maintenance state
      description: |-
        Puts storage pool into maintenance state

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StorageMaintenance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableStorageMaintenance
          default: enableStorageMaintenance
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Primary storage ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - enableStorageMaintenance
      responses:
        '200':
          description: Successful invocation of `enableStorageMaintenance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablestoragemaintenanceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - enablestoragemaintenanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enablestoragemaintenanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enablestoragemaintenanceresponse
      x-cloudstack-command: enableStorageMaintenance
      x-cloudstack-async: true
      x-cloudstack-related:
      - cancelStorageMaintenance
      x-cloudstack-jobresult-schema: '#/components/schemas/StoragePool'
  /enableUser:
    get:
      operationId: enableUser
      summary: Enables a user account
      tags:
      - User
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: enableUser
          default: enableUser
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Enables user by user ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
      responses:
        '200':
          description: Successful invocation of `enableUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableuserresponse:
                    oneOf:
                    - &id146
                      $ref: '#/components/schemas/User2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id146
                        - type: array
                          items: *id146
                required:
                - enableuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  enableuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - enableuserresponse
      x-cloudstack-command: enableUser
      x-cloudstack-async: false
      x-cloudstack-related:
      - createUser
      - disableUser
      - getUser
      - listUsers
      - lockUser
  /executeClusterDrsPlan:
    get:
      operationId: executeClusterDrsPlan
      summary: Execute DRS for a cluster.
      description: |-
        Execute DRS for a cluster. If there is another plan in progress for the same cluster, this command will fail.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ExecuteClusterDrsPlan
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: executeClusterDrsPlan
          default: executeClusterDrsPlan
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: migrateto
        in: query
        description: 'Virtual Machine to destination host mapping. This parameter specifies the mapping between a vm and a host to migrate that VM. clusterid is required if this parameter is set.Format of this parameter: migrateto[vm-index].vm=<uuid>&migrateto[vm-index].host=<uuid> Where, [vm-index] indicates the index to identify the vm that you want to migrate, vm=<uuid> indicates the UUID of the vm that you want to migrate, and host=<uuid> indicates the UUID of the host where you want to migrate the vm. Example: migrateto[0].vm=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].host=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].vm=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].host=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].vm=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].host=<41fdb564-9d3b-447d-88ed-7628f7640cbc>. Map parameter. CloudStack expects it index-encoded as `migrateto[0].key=k&migrateto[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `executeClusterDrsPlan`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  executeclusterdrsplanresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - executeclusterdrsplanresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  executeclusterdrsplanresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - executeclusterdrsplanresponse
      x-cloudstack-command: executeClusterDrsPlan
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-jobresult-schema: '#/components/schemas/ClusterDrsPlan'
  /executeWebhookDelivery:
    get:
      operationId: executeWebhookDelivery
      summary: Executes a Webhook delivery
      tags:
      - ExecuteWebhookDelivery
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: executeWebhookDelivery
          default: executeWebhookDelivery
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Webhook delivery for redelivery
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - executeWebhookDelivery
      - name: payload
        in: query
        description: Payload of the Webhook delivery
        schema:
          type: string
          maxLength: 255
      - name: payloadurl
        in: query
        description: Payload URL of the Webhook delivery
        schema:
          type: string
          maxLength: 255
      - name: secretkey
        in: query
        description: Secret key of the Webhook delivery
        schema:
          type: string
          maxLength: 255
      - name: sslverification
        in: query
        description: If set to true then SSL verification will be done for the Webhook delivery otherwise not
        schema:
          type: boolean
      - name: webhookid
        in: query
        description: The ID of the Webhook
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addWebhookFilter
        - createWebhook
        - listWebhookDeliveries
        - updateWebhook
      responses:
        '200':
          description: Successful invocation of `executeWebhookDelivery`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  executewebhookdeliveryresponse:
                    oneOf:
                    - &id147
                      $ref: '#/components/schemas/ExecuteWebhookDelivery'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id147
                        - type: array
                          items: *id147
                required:
                - executewebhookdeliveryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  executewebhookdeliveryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - executewebhookdeliveryresponse
      x-cloudstack-command: executeWebhookDelivery
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /expungeSharedFileSystem:
    get:
      operationId: expungeSharedFileSystem
      summary: Expunge a Shared FileSystem by id
      description: |-
        Expunge a Shared FileSystem by id

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: expungeSharedFileSystem
          default: expungeSharedFileSystem
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the shared filesystem to expunge
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `expungeSharedFileSystem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  expungesharedfilesystemresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - expungesharedfilesystemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  expungesharedfilesystemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - expungesharedfilesystemresponse
      x-cloudstack-command: expungeSharedFileSystem
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /expungeVirtualMachine:
    get:
      operationId: expungeVirtualMachine
      summary: Expunge  an Instance.
      description: |-
        Expunge  an Instance. Once expunged, it cannot be recovered.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: expungeVirtualMachine
          default: expungeVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `expungeVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  expungevirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - expungevirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  expungevirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - expungevirtualmachineresponse
      x-cloudstack-command: expungeVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /extractIso:
    get:
      operationId: extractIso
      summary: Extracts an ISO
      description: |-
        Extracts an ISO

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Iso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: extractIso
          default: extractIso
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the ISO file
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: mode
        in: query
        description: The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The URL to which the ISO would be extracted
        schema:
          type: string
          maxLength: 2048
      - name: zoneid
        in: query
        description: The ID of the zone where the ISO is originally located
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `extractIso`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  extractisoresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - extractisoresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  extractisoresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - extractisoresponse
      x-cloudstack-command: extractIso
      x-cloudstack-async: true
      x-cloudstack-related:
      - downloadImageStoreObject
      - downloadValidationScreenshot
      - extractSnapshot
      - extractTemplate
      x-cloudstack-jobresult-schema: '#/components/schemas/DownloadImageStoreObjectResult'
  /extractSnapshot:
    get:
      operationId: extractSnapshot
      summary: Returns a download URL for extracting a snapshot.
      description: |-
        Returns a download URL for extracting a snapshot. It must be in the Backed Up state.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Snapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: extractSnapshot
          default: extractSnapshot
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the snapshot
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.20.0
        x-cloudstack-related:
        - listSnapshots
      - name: zoneid
        in: query
        description: the ID of the zone where the snapshot is located
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.20.0
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `extractSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  extractsnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - extractsnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  extractsnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - extractsnapshotresponse
      x-cloudstack-command: extractSnapshot
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/DownloadImageStoreObjectResult'
  /extractTemplate:
    get:
      operationId: extractTemplate
      summary: Extracts a Template
      description: |-
        Extracts a Template

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: extractTemplate
          default: extractTemplate
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Template
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: mode
        in: query
        description: The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The url to which the ISO would be extracted
        schema:
          type: string
          maxLength: 2048
      - name: zoneid
        in: query
        description: The ID of the zone where the ISO is originally located
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `extractTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  extracttemplateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - extracttemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  extracttemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - extracttemplateresponse
      x-cloudstack-command: extractTemplate
      x-cloudstack-async: true
      x-cloudstack-related:
      - extractSnapshot
      x-cloudstack-jobresult-schema: '#/components/schemas/DownloadImageStoreObjectResult'
  /extractVolume:
    get:
      operationId: extractVolume
      summary: Extracts volume
      description: |-
        Extracts volume

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: extractVolume
          default: extractVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: mode
        in: query
        description: The mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of the zone where the volume is located
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: url
        in: query
        description: The URL to which the volume would be extracted
        schema:
          type: string
          maxLength: 2048
      responses:
        '200':
          description: Successful invocation of `extractVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  extractvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - extractvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  extractvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - extractvolumeresponse
      x-cloudstack-command: extractVolume
      x-cloudstack-async: true
      x-cloudstack-related:
      - downloadImageStoreObject
      - downloadValidationScreenshot
      - extractIso
      - extractSnapshot
      - extractTemplate
      x-cloudstack-jobresult-schema: '#/components/schemas/DownloadImageStoreObjectResult'
  /findHostsForMigration:
    get:
      operationId: findHostsForMigration
      summary: Find hosts suitable for migrating an Instance.
      tags:
      - HostsForMigration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: findHostsForMigration
          default: findHostsForMigration
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: Find hosts to which this Instance can be migrated and flag the hosts with enough CPU/RAM to host the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `findHostsForMigration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  findhostsformigrationresponse:
                    oneOf:
                    - &id148
                      $ref: '#/components/schemas/HostsForMigration'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id148
                        - type: array
                          items: *id148
                required:
                - findhostsformigrationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  findhostsformigrationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - findhostsformigrationresponse
      x-cloudstack-command: findHostsForMigration
      x-cloudstack-async: false
  /findStoragePoolsForMigration:
    get:
      operationId: findStoragePoolsForMigration
      summary: Lists storage pools available for migration of a volume.
      tags:
      - StoragePoolsForMigration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: findStoragePoolsForMigration
          default: findStoragePoolsForMigration
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `findStoragePoolsForMigration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  findstoragepoolsformigrationresponse:
                    oneOf:
                    - &id149
                      $ref: '#/components/schemas/StoragePool'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id149
                        - type: array
                          items: *id149
                required:
                - findstoragepoolsformigrationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  findstoragepoolsformigrationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - findstoragepoolsformigrationresponse
      x-cloudstack-command: findStoragePoolsForMigration
      x-cloudstack-async: false
      x-cloudstack-related:
      - cancelStorageMaintenance
      - enableStorageMaintenance
  /finishBackupChain:
    get:
      operationId: finishBackupChain
      summary: Finish the backup chain of VM.
      description: Finish the backup chain of VM. Currently only has effect on VMs with KBOSS backup offerings.
      tags:
      - FinishBackupChain
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: finishBackupChain
          default: finishBackupChain
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: ID of the VM to finish the chain.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `finishBackupChain`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  finishbackupchainresponse:
                    oneOf:
                    - &id150
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id150
                        - type: array
                          items: *id150
                required:
                - finishbackupchainresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  finishbackupchainresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - finishbackupchainresponse
      x-cloudstack-command: finishBackupChain
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /generateAlert:
    get:
      operationId: generateAlert
      summary: Generates an alert
      description: |-
        Generates an alert

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Alert
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: generateAlert
          default: generateAlert
      - $ref: '#/components/parameters/response'
      - name: description
        in: query
        description: Alert description
        required: true
        schema:
          type: string
          maxLength: 999
      - name: name
        in: query
        description: Name of the alert
        required: true
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: Type of the alert
        required: true
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: Pod id for which alert is generated
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: zoneid
        in: query
        description: Zone id for which alert is generated
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `generateAlert`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  generatealertresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - generatealertresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  generatealertresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - generatealertresponse
      x-cloudstack-command: generateAlert
      x-cloudstack-async: true
      x-cloudstack-since: '4.3'
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /generateClusterDrsPlan:
    get:
      operationId: generateClusterDrsPlan
      summary: Generate DRS plan for a cluster
      tags:
      - ClusterDrsPlan
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: generateClusterDrsPlan
          default: generateClusterDrsPlan
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the Cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: migrations
        in: query
        description: Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `generateClusterDrsPlan`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  generateclusterdrsplanresponse:
                    oneOf:
                    - &id151
                      $ref: '#/components/schemas/ClusterDrsPlan'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id151
                        - type: array
                          items: *id151
                required:
                - generateclusterdrsplanresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  generateclusterdrsplanresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - generateclusterdrsplanresponse
      x-cloudstack-command: generateClusterDrsPlan
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - executeClusterDrsPlan
  /generateUsageRecords:
    get:
      operationId: generateUsageRecords
      summary: Generates usage records.
      description: Generates usage records. This will generate records only if there any records to be generated, i.e if the scheduled usage job was not run or failed
      tags:
      - UsageRecord
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: generateUsageRecords
          default: generateUsageRecords
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: List events for the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: enddate
        in: query
        description: End date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-03. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: startdate
        in: query
        description: Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `generateUsageRecords`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  generateusagerecordsresponse:
                    oneOf:
                    - &id152
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id152
                        - type: array
                          items: *id152
                required:
                - generateusagerecordsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  generateusagerecordsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - generateusagerecordsresponse
      x-cloudstack-command: generateUsageRecords
      x-cloudstack-async: false
  /getApiLimit:
    get:
      operationId: getApiLimit
      summary: Get API limit count for the caller
      tags:
      - ApiLimit
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getApiLimit
          default: getApiLimit
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `getApiLimit`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getapilimitresponse:
                    oneOf:
                    - &id153
                      $ref: '#/components/schemas/ApiLimit'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id153
                        - type: array
                          items: *id153
                required:
                - getapilimitresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getapilimitresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getapilimitresponse
      x-cloudstack-command: getApiLimit
      x-cloudstack-async: false
  /getCloudIdentifier:
    get:
      operationId: getCloudIdentifier
      summary: Retrieves a cloud identifier.
      tags:
      - CloudIdentifier
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getCloudIdentifier
          default: getCloudIdentifier
      - $ref: '#/components/parameters/response'
      - name: userid
        in: query
        description: The user ID for the cloud identifier
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - getUser
      responses:
        '200':
          description: Successful invocation of `getCloudIdentifier`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getcloudidentifierresponse:
                    oneOf:
                    - &id154
                      $ref: '#/components/schemas/CloudIdentifier'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id154
                        - type: array
                          items: *id154
                required:
                - getcloudidentifierresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getcloudidentifierresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getcloudidentifierresponse
      x-cloudstack-command: getCloudIdentifier
      x-cloudstack-async: false
  /getDiagnosticsData:
    get:
      operationId: getDiagnosticsData
      summary: Get diagnostics and files from System VMs
      description: |-
        Get diagnostics and files from System VMs

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DiagnosticsData
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getDiagnosticsData
          default: getDiagnosticsData
      - $ref: '#/components/parameters/response'
      - name: targetid
        in: query
        description: The ID of the System VM to retrieve diagnostics data files from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: files
        in: query
        description: A comma separated list of diagnostics data files to be retrieved. Defaults are taken from global settings if none has been provided. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `getDiagnosticsData`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getdiagnosticsdataresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - getdiagnosticsdataresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getdiagnosticsdataresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getdiagnosticsdataresponse
      x-cloudstack-command: getDiagnosticsData
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/DiagnosticsData'
  /getHypervisorGuestOsNames:
    get:
      operationId: getHypervisorGuestOsNames
      summary: Gets the guest OS names in the hypervisor
      description: |-
        Gets the guest OS names in the hypervisor

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - HypervisorGuestOsName
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getHypervisorGuestOsNames
          default: getHypervisorGuestOsNames
      - $ref: '#/components/parameters/response'
      - name: hypervisor
        in: query
        description: 'Hypervisor type. One of : VMware, XenServer'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hypervisorversion
        in: query
        description: Hypervisor version to get the guest OS names (at least one hypervisor host with the version specified must be available)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: Keyword for guest OS name
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getHypervisorGuestOsNames`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  gethypervisorguestosnamesresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - gethypervisorguestosnamesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  gethypervisorguestosnamesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - gethypervisorguestosnamesresponse
      x-cloudstack-command: getHypervisorGuestOsNames
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-jobresult-schema: '#/components/schemas/HypervisorGuestOsName'
  /getKubernetesClusterConfig:
    get:
      operationId: getKubernetesClusterConfig
      summary: Get Kubernetes cluster config
      tags:
      - KubernetesClusterConfig
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getKubernetesClusterConfig
          default: getKubernetesClusterConfig
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
      responses:
        '200':
          description: Successful invocation of `getKubernetesClusterConfig`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getkubernetesclusterconfigresponse:
                    oneOf:
                    - &id155
                      $ref: '#/components/schemas/KubernetesClusterConfig'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id155
                        - type: array
                          items: *id155
                required:
                - getkubernetesclusterconfigresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getkubernetesclusterconfigresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getkubernetesclusterconfigresponse
      x-cloudstack-command: getKubernetesClusterConfig
      x-cloudstack-async: false
  /getLoadBalancerSslCertificate:
    get:
      operationId: getLoadBalancerSslCertificate
      summary: Get load balancer certificate
      tags:
      - Certificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getLoadBalancerSslCertificate
          default: getLoadBalancerSslCertificate
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of Lb
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - getLoadBalancerSslCertificate
      responses:
        '200':
          description: Successful invocation of `getLoadBalancerSslCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getloadbalancersslcertificateresponse:
                    oneOf:
                    - &id156
                      $ref: '#/components/schemas/LoadBalancerSslCertificate'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id156
                        - type: array
                          items: *id156
                required:
                - getloadbalancersslcertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getloadbalancersslcertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getloadbalancersslcertificateresponse
      x-cloudstack-command: getLoadBalancerSslCertificate
      x-cloudstack-async: false
  /getPathForVolume:
    get:
      operationId: getPathForVolume
      summary: Get the path associated with the provided volume UUID
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getPathForVolume
          default: getPathForVolume
      - $ref: '#/components/parameters/response'
      - name: volumeid
        in: query
        description: CloudStack Volume UUID
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getPathForVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getpathforvolumeresponse:
                    oneOf:
                    - &id157
                      $ref: '#/components/schemas/PathForVolume'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id157
                        - type: array
                          items: *id157
                required:
                - getpathforvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getpathforvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getpathforvolumeresponse
      x-cloudstack-command: getPathForVolume
      x-cloudstack-async: false
  /getRouterHealthCheckResults:
    get:
      operationId: getRouterHealthCheckResults
      summary: Starts a router.
      tags:
      - RouterHealthCheckResult
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getRouterHealthCheckResults
          default: getRouterHealthCheckResults
      - $ref: '#/components/parameters/response'
      - name: routerid
        in: query
        description: The ID of the router
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - destroyRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - rebootRouter
        - stopInternalLoadBalancerVM
        - stopNetScalerVpx
        - stopRouter
      - name: performfreshchecks
        in: query
        description: If true is passed for this parameter, health checks are performed on the fly. Else last performed checks data is fetched
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `getRouterHealthCheckResults`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getrouterhealthcheckresultsresponse:
                    oneOf:
                    - &id158
                      $ref: '#/components/schemas/RouterHealthCheckResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id158
                        - type: array
                          items: *id158
                required:
                - getrouterhealthcheckresultsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getrouterhealthcheckresultsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getrouterhealthcheckresultsresponse
      x-cloudstack-command: getRouterHealthCheckResults
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
  /getSolidFireAccountId:
    get:
      operationId: getSolidFireAccountId
      summary: Get SolidFire Account ID
      tags:
      - SolidFireAccountId
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getSolidFireAccountId
          default: getSolidFireAccountId
      - $ref: '#/components/parameters/response'
      - name: accountid
        in: query
        description: CloudStack Account UUID
        required: true
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: Storage Pool UUID
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getSolidFireAccountId`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getsolidfireaccountidresponse:
                    oneOf:
                    - &id159
                      $ref: '#/components/schemas/SolidFireAccountId'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id159
                        - type: array
                          items: *id159
                required:
                - getsolidfireaccountidresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getsolidfireaccountidresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getsolidfireaccountidresponse
      x-cloudstack-command: getSolidFireAccountId
      x-cloudstack-async: false
  /getSolidFireVolumeAccessGroupIds:
    get:
      operationId: getSolidFireVolumeAccessGroupIds
      summary: Get the SF Volume Access Group IDs
      tags:
      - SolidFireVolumeAccessGroupId
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getSolidFireVolumeAccessGroupIds
          default: getSolidFireVolumeAccessGroupIds
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: Cluster UUID
        required: true
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: Storage Pool UUID
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getSolidFireVolumeAccessGroupIds`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getsolidfirevolumeaccessgroupidsresponse:
                    oneOf:
                    - &id160
                      $ref: '#/components/schemas/SolidFireVolumeAccessGroupId'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id160
                        - type: array
                          items: *id160
                required:
                - getsolidfirevolumeaccessgroupidsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getsolidfirevolumeaccessgroupidsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getsolidfirevolumeaccessgroupidsresponse
      x-cloudstack-command: getSolidFireVolumeAccessGroupIds
      x-cloudstack-async: false
  /getSolidFireVolumeSize:
    get:
      operationId: getSolidFireVolumeSize
      summary: Get the SF volume size including Hypervisor Snapshot Reserve
      tags:
      - SolidFireVolumeSize
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getSolidFireVolumeSize
          default: getSolidFireVolumeSize
      - $ref: '#/components/parameters/response'
      - name: volumeid
        in: query
        description: Volume UUID
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getSolidFireVolumeSize`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getsolidfirevolumesizeresponse:
                    oneOf:
                    - &id161
                      $ref: '#/components/schemas/SolidFireVolumeSize'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id161
                        - type: array
                          items: *id161
                required:
                - getsolidfirevolumesizeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getsolidfirevolumesizeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getsolidfirevolumesizeresponse
      x-cloudstack-command: getSolidFireVolumeSize
      x-cloudstack-async: false
  /getUploadParamsForIso:
    get:
      operationId: getUploadParamsForIso
      summary: Upload an existing ISO into the CloudStack cloud.
      tags:
      - UploadParamsForIso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getUploadParamsForIso
          default: getUploadParamsForIso
      - $ref: '#/components/parameters/response'
      - name: format
        in: query
        description: The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Volume/Template/ISO
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of the zone the Volume/Template/ISO is to be hosted on
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: An optional accountName. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: bootable
        in: query
        description: True if this ISO is bootable. If not passed explicitly its assumed to be true
        schema:
          type: boolean
      - name: checksum
        in: query
        description: |-
          The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: displaytext
        in: query
        description: The display text of the ISO. This is usually used for display purposes.
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: An optional domainId. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: isextractable
        in: query
        description: True if the ISO or its derivatives are extractable; default is false
        schema:
          type: boolean
      - name: isfeatured
        in: query
        description: True if you want this ISO to be featured
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: True if you want to register the ISO to be publicly available to all Users, false otherwise.
        schema:
          type: boolean
      - name: ostypeid
        in: query
        description: The ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: projectid
        in: query
        description: Upload Volume/Template/ISO for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getUploadParamsForIso`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuploadparamsforisoresponse:
                    oneOf:
                    - &id162
                      $ref: '#/components/schemas/GetUploadParamsForIsoResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id162
                        - type: array
                          items: *id162
                required:
                - getuploadparamsforisoresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuploadparamsforisoresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getuploadparamsforisoresponse
      x-cloudstack-command: getUploadParamsForIso
      x-cloudstack-async: false
      x-cloudstack-since: '4.13'
  /getUploadParamsForKubernetesSupportedVersion:
    get:
      operationId: getUploadParamsForKubernetesSupportedVersion
      summary: Upload a supported Kubernetes version
      tags:
      - KubernetesSupportedVersion
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getUploadParamsForKubernetesSupportedVersion
          default: getUploadParamsForKubernetesSupportedVersion
      - $ref: '#/components/parameters/response'
      - name: format
        in: query
        description: The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: mincpunumber
        in: query
        description: the minimum number of CPUs to be set with the Kubernetes version
        required: true
        schema:
          type: integer
          format: int32
      - name: minmemory
        in: query
        description: the minimum RAM size in MB to be set with the Kubernetes version
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: The name of the Volume/Template/ISO
        required: true
        schema:
          type: string
          maxLength: 255
      - name: semanticversion
        in: query
        description: the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of the zone the Volume/Template/ISO is to be hosted on
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: An optional accountName. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: checksum
        in: query
        description: |-
          The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: projectid
        in: query
        description: Upload Volume/Template/ISO for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getUploadParamsForKubernetesSupportedVersion`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuploadparamsforkubernetessupportedversionresponse:
                    oneOf:
                    - &id163
                      $ref: '#/components/schemas/KubernetesSupportedVersion'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id163
                        - type: array
                          items: *id163
                required:
                - getuploadparamsforkubernetessupportedversionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuploadparamsforkubernetessupportedversionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getuploadparamsforkubernetessupportedversionresponse
      x-cloudstack-command: getUploadParamsForKubernetesSupportedVersion
      x-cloudstack-async: false
  /getUploadParamsForTemplate:
    get:
      operationId: getUploadParamsForTemplate
      summary: Upload an existing Template into the CloudStack cloud.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getUploadParamsForTemplate
          default: getUploadParamsForTemplate
      - $ref: '#/components/parameters/response'
      - name: format
        in: query
        description: The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hypervisor
        in: query
        description: The target hypervisor for the Template
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Volume/Template/ISO
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of the zone the Volume/Template/ISO is to be hosted on
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: An optional accountName. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: bits
        in: query
        description: 32 or 64 bits support. 64 by default
        schema:
          type: integer
          format: int32
      - name: checksum
        in: query
        description: |-
          The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: deployasis
        in: query
        description: (VMware only) true if Instance deployments should preserve all the configurations defined for this Template
        schema:
          type: boolean
        x-cloudstack-since: 4.15.1
      - name: details
        in: query
        description: Template details in key/value pairs. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: displaytext
        in: query
        description: The display text of the Template. This is usually used for display purposes.
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: An optional domainId. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: forcks
        in: query
        description: if true, the templates would be available for deploying CKS clusters
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: isdynamicallyscalable
        in: query
        description: True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
        schema:
          type: boolean
      - name: isextractable
        in: query
        description: True if the Template or its derivatives are extractable; default is false
        schema:
          type: boolean
      - name: isfeatured
        in: query
        description: True if this Template is a featured Template, false otherwise
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: True if the Template is available to all accounts; default is true
        schema:
          type: boolean
      - name: isrouting
        in: query
        description: True if the Template type is routing i.e., if Template is used to deploy router
        schema:
          type: boolean
      - name: ostypeid
        in: query
        description: The ID of the OS Type that best represents the OS of this Template. Not required for VMware as the guest OS is obtained from the OVF file.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: passwordenabled
        in: query
        description: True if the Template supports the password reset feature; default is false
        schema:
          type: boolean
      - name: projectid
        in: query
        description: Upload Volume/Template/ISO for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: requireshvm
        in: query
        description: True if this Template requires HVM
        schema:
          type: boolean
      - name: sshkeyenabled
        in: query
        description: True if the Template supports the SSHkey upload feature; default is false
        schema:
          type: boolean
      - name: templatetag
        in: query
        description: The tag for this Template.
        schema:
          type: string
          maxLength: 255
      - name: templatetype
        in: query
        description: 'the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.22.0
      responses:
        '200':
          description: Successful invocation of `getUploadParamsForTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuploadparamsfortemplateresponse:
                    oneOf:
                    - &id164
                      $ref: '#/components/schemas/GetUploadParamsForIsoResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id164
                        - type: array
                          items: *id164
                required:
                - getuploadparamsfortemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuploadparamsfortemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getuploadparamsfortemplateresponse
      x-cloudstack-command: getUploadParamsForTemplate
      x-cloudstack-async: false
      x-cloudstack-since: 4.6.0
      x-cloudstack-related:
      - getUploadParamsForIso
  /getUploadParamsForVolume:
    get:
      operationId: getUploadParamsForVolume
      summary: Upload a data disk to the cloudstack cloud.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getUploadParamsForVolume
          default: getUploadParamsForVolume
      - $ref: '#/components/parameters/response'
      - name: format
        in: query
        description: The format for the Volume/Template/ISO. Possible values include QCOW2, OVA, and VHD.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Volume/Template/ISO
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of the zone the Volume/Template/ISO is to be hosted on
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: An optional accountName. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: checksum
        in: query
        description: |-
          The checksum value of this Volume/Template/ISO The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: diskofferingid
        in: query
        description: The ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: imagestoreuuid
        in: query
        description: Image store uuid
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: Upload Volume/Template/ISO for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getUploadParamsForVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuploadparamsforvolumeresponse:
                    oneOf:
                    - &id165
                      $ref: '#/components/schemas/GetUploadParamsForIsoResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id165
                        - type: array
                          items: *id165
                required:
                - getuploadparamsforvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuploadparamsforvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getuploadparamsforvolumeresponse
      x-cloudstack-command: getUploadParamsForVolume
      x-cloudstack-async: false
      x-cloudstack-since: 4.6.0
      x-cloudstack-related:
      - getUploadParamsForIso
      - getUploadParamsForTemplate
  /getUser:
    get:
      operationId: getUser
      summary: Find user account by API key
      tags:
      - User
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getUser
          default: getUser
      - $ref: '#/components/parameters/response'
      - name: userapikey
        in: query
        description: API key of the user
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuserresponse:
                    oneOf:
                    - &id166
                      $ref: '#/components/schemas/User2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id166
                        - type: array
                          items: *id166
                required:
                - getuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getuserresponse
      x-cloudstack-command: getUser
      x-cloudstack-async: false
  /getUserKeys:
    get:
      operationId: getUserKeys
      summary: Queries the last registered secret and API keys of a user.
      tags:
      - UserKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getUserKeys
          default: getUserKeys
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the user whose keys are required
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
        - lockUser
      responses:
        '200':
          description: Successful invocation of `getUserKeys`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuserkeysresponse:
                    oneOf:
                    - &id167
                      $ref: '#/components/schemas/UserKey'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id167
                        - type: array
                          items: *id167
                required:
                - getuserkeysresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getuserkeysresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getuserkeysresponse
      x-cloudstack-command: getUserKeys
      x-cloudstack-async: false
      x-cloudstack-since: 4.10.0
  /getVMPassword:
    get:
      operationId: getVMPassword
      summary: Returns an encrypted password for the Instance
      tags:
      - VMPassword
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getVMPassword
          default: getVMPassword
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `getVMPassword`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getvmpasswordresponse:
                    oneOf:
                    - &id168
                      $ref: '#/components/schemas/VMPassword'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id168
                        - type: array
                          items: *id168
                required:
                - getvmpasswordresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getvmpasswordresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getvmpasswordresponse
      x-cloudstack-command: getVMPassword
      x-cloudstack-async: false
  /getVirtualMachineUserData:
    get:
      operationId: getVirtualMachineUserData
      summary: Returns user data associated with the Instance
      tags:
      - UserData
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getVirtualMachineUserData
          default: getVirtualMachineUserData
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `getVirtualMachineUserData`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getvirtualmachineuserdataresponse:
                    oneOf:
                    - &id169
                      $ref: '#/components/schemas/VirtualMachineUserData'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id169
                        - type: array
                          items: *id169
                required:
                - getvirtualmachineuserdataresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getvirtualmachineuserdataresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getvirtualmachineuserdataresponse
      x-cloudstack-command: getVirtualMachineUserData
      x-cloudstack-async: false
      x-cloudstack-since: '4.4'
  /getVolumeSnapshotDetails:
    get:
      operationId: getVolumeSnapshotDetails
      summary: Get Volume Snapshot Details
      tags:
      - VolumeSnapshotDetail
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getVolumeSnapshotDetails
          default: getVolumeSnapshotDetails
      - $ref: '#/components/parameters/response'
      - name: snapshotid
        in: query
        description: CloudStack Snapshot UUID
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getVolumeSnapshotDetails`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getvolumesnapshotdetailsresponse:
                    oneOf:
                    - &id170
                      $ref: '#/components/schemas/GetVolumeSnapshotDetailsResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id170
                        - type: array
                          items: *id170
                required:
                - getvolumesnapshotdetailsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getvolumesnapshotdetailsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getvolumesnapshotdetailsresponse
      x-cloudstack-command: getVolumeSnapshotDetails
      x-cloudstack-async: false
      x-cloudstack-related:
      - getVolumeiScsiName
  /getVolumeiScsiName:
    get:
      operationId: getVolumeiScsiName
      summary: Get Volume's iSCSI Name
      tags:
      - VolumeiScsiName
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: getVolumeiScsiName
          default: getVolumeiScsiName
      - $ref: '#/components/parameters/response'
      - name: volumeid
        in: query
        description: CloudStack Volume UUID
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `getVolumeiScsiName`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getvolumeiscsinameresponse:
                    oneOf:
                    - &id171
                      $ref: '#/components/schemas/GetVolumeSnapshotDetailsResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id171
                        - type: array
                          items: *id171
                required:
                - getvolumeiscsinameresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  getvolumeiscsinameresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - getvolumeiscsinameresponse
      x-cloudstack-command: getVolumeiScsiName
      x-cloudstack-async: false
  /importBackupOffering:
    get:
      operationId: importBackupOffering
      summary: Imports a backup offering using a backup provider
      description: |-
        Imports a backup offering using a backup provider

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BackupOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: importBackupOffering
          default: importBackupOffering
      - $ref: '#/components/parameters/response'
      - name: allowuserdrivenbackups
        in: query
        description: Whether users are allowed to create adhoc backups and backup schedules
        required: true
        schema:
          type: boolean
      - name: description
        in: query
        description: The description of the backup offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: externalid
        in: query
        description: The backup offering ID (from backup provider side)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the backup offering
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: domainid
        in: query
        description: the ID of the containing domain(s), null for public offerings. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      responses:
        '200':
          description: Successful invocation of `importBackupOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importbackupofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - importbackupofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importbackupofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - importbackupofferingresponse
      x-cloudstack-command: importBackupOffering
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-related:
      - cloneBackupOffering
      - createBackupOffering
      - listBackupOfferings
      - updateBackupOffering
      x-cloudstack-jobresult-schema: '#/components/schemas/BackupOffering'
  /importLdapUsers:
    get:
      operationId: importLdapUsers
      summary: Import LDAP users
      tags:
      - LdapUser
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: importLdapUsers
          default: importLdapUsers
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Creates the user under the specified account. If no account is specified, the username will be used as the account name.
        schema:
          type: string
          maxLength: 255
      - name: accountdetails
        in: query
        description: Details for account used to store specific parameters. Map parameter. CloudStack expects it index-encoded as `accountdetails[0].key=k&accountdetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: accounttype
        in: query
        description: Type of the account.  Specify 0 for user, 1 for root admin, and 2 for domain admin
        schema:
          type: integer
          format: int32
      - name: domainid
        in: query
        description: Specifies the domain to which the ldap users are to be imported. If no domain is specified, a domain will created using group parameter. If the group is also not specified, a domain name based on the OU information will be created. If no OU hierarchy exists, will be defaulted to ROOT domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: group
        in: query
        description: Specifies the group name from which the ldap users are to be imported. If no group is specified, all the users will be imported.
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: roleid
        in: query
        description: Creates the account under the specified role.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - listRoles
        - updateRole
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `importLdapUsers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importldapusersresponse:
                    oneOf:
                    - &id172
                      $ref: '#/components/schemas/LdapUser'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id172
                        - type: array
                          items: *id172
                required:
                - importldapusersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importldapusersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - importldapusersresponse
      x-cloudstack-command: importLdapUsers
      x-cloudstack-async: false
      x-cloudstack-since: 4.3.0
      x-cloudstack-related:
      - searchLdap
  /importNetworkACL:
    get:
      operationId: importNetworkACL
      summary: Imports Network ACL rules.
      description: |-
        Imports Network ACL rules.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkACL
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: importNetworkACL
          default: importNetworkACL
      - $ref: '#/components/parameters/response'
      - name: aclid
        in: query
        description: The ID of the Network ACL to which the rules will be imported
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
        - listNetworkACLLists
      - name: rules
        in: query
        description: 'Rules param list, id and protocol are must. Invalid rules will be discarded. Example: rules[0].id=101&rules[0].protocol=tcp&rules[0].traffictype=ingress&rules[0].state=active&rules[0].cidrlist=192.168.1.0/24&rules[0].tags=web&rules[0].aclid=acl-001&rules[0].aclname=web-acl&rules[0].number=1&rules[0].action=allow&rules[0].fordisplay=true&rules[0].description=allow%20web%20traffic&rules[1].id=102&rules[1].protocol=udp&rules[1].traffictype=egress&rules[1].state=enabled&rules[1].cidrlist=10.0.0.0/8&rules[1].tags=db&rules[1].aclid=acl-002&rules[1].aclname=db-acl&rules[1].number=2&rules[1].action=deny&rules[1].fordisplay=false&rules[1].description=deny%20database%20traffic. Map parameter. CloudStack expects it index-encoded as `rules[0].key=k&rules[0].value=v`.'
        required: true
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `importNetworkACL`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importnetworkaclresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - importnetworkaclresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importnetworkaclresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - importnetworkaclresponse
      x-cloudstack-command: importNetworkACL
      x-cloudstack-async: true
      x-cloudstack-since: 4.22.1
      x-cloudstack-related:
      - createNetworkACL
      - moveNetworkAclItem
      - updateNetworkACLItem
      x-cloudstack-jobresult-schema: '#/components/schemas/NetworkACL'
  /importRole:
    get:
      operationId: importRole
      summary: Imports a role based on provided map of rule permissions
      tags:
      - Role
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: importRole
          default: importRole
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Creates a role with this unique name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: rules
        in: query
        description: 'Rules param list, rule and permission is must. Example: rules[0].rule=create*&rules[0].permission=allow&rules[0].description=create%20rule&rules[1].rule=list*&rules[1].permission=allow&rules[1].description=listing. Map parameter. CloudStack expects it index-encoded as `rules[0].key=k&rules[0].value=v`.'
        required: true
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: description
        in: query
        description: The description of the role
        schema:
          type: string
          maxLength: 255
      - name: forced
        in: query
        description: Force create a role with the same name. This overrides the role type, description and rule permissions for the existing role. Default is false.
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: Indicates whether the role will be visible to all users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).
        schema:
          type: boolean
      - name: type
        in: query
        description: 'The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `importRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importroleresponse:
                    oneOf:
                    - &id173
                      $ref: '#/components/schemas/Role'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id173
                        - type: array
                          items: *id173
                required:
                - importroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - importroleresponse
      x-cloudstack-command: importRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
      x-cloudstack-related:
      - createRole
      - listRoles
      - updateRole
  /importUnmanagedInstance:
    get:
      operationId: importUnmanagedInstance
      summary: Import unmanaged Instance from a given cluster.
      description: |-
        Import unmanaged Instance from a given cluster.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - UnmanagedInstance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: importUnmanagedInstance
          default: importUnmanagedInstance
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: The cluster ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: name
        in: query
        description: The name of the Instance as it is known to the hypervisor
        required: true
        schema:
          type: string
          maxLength: 255
      - name: serviceofferingid
        in: query
        description: The service offering for the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: account
        in: query
        description: An optional account for the Instance. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: datadiskofferinglist
        in: query
        description: Datadisk Template to disk-offering mapping using keys disk and diskOffering. Map parameter. CloudStack expects it index-encoded as `datadiskofferinglist[0].key=k&datadiskofferinglist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: details
        in: query
        description: Used to specify the custom parameters. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: displayname
        in: query
        description: The display name of the Instance
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Import Instance to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: forced
        in: query
        description: Instance is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated
        schema:
          type: boolean
      - name: hostname
        in: query
        description: The host name of the Instance
        schema:
          type: string
          maxLength: 255
      - name: migrateallowed
        in: query
        description: Instance and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool
        schema:
          type: boolean
      - name: nicipaddresslist
        in: query
        description: VM NIC to ip address mapping using keys NIC, ip4Address. Map parameter. CloudStack expects it index-encoded as `nicipaddresslist[0].key=k&nicipaddresslist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: nicnetworklist
        in: query
        description: VM NIC to network id mapping using keys NIC and network. Map parameter. CloudStack expects it index-encoded as `nicnetworklist[0].key=k&nicnetworklist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: projectid
        in: query
        description: Import Instance for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
      - name: templateid
        in: query
        description: The ID of the Template for the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      responses:
        '200':
          description: Successful invocation of `importUnmanagedInstance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importunmanagedinstanceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - importunmanagedinstanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importunmanagedinstanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - importunmanagedinstanceresponse
      x-cloudstack-command: importUnmanagedInstance
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /importVm:
    get:
      operationId: importVm
      summary: Import virtual machine from a unmanaged host into CloudStack
      description: |-
        Import virtual machine from a unmanaged host into CloudStack

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Vm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: importVm
          default: importVm
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: The cluster ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: hypervisor
        in: query
        description: hypervisor type of the host
        required: true
        schema:
          type: string
          maxLength: 255
      - name: importsource
        in: query
        description: Source location for Import
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Instance as it is known to the hypervisor
        required: true
        schema:
          type: string
          maxLength: 255
      - name: serviceofferingid
        in: query
        description: The service offering for the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateServiceOffering
      - name: zoneid
        in: query
        description: the zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: An optional account for the Instance. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: clustername
        in: query
        description: (only for importing VMs from VMware to KVM) Name of VMware cluster.
        schema:
          type: string
          maxLength: 255
      - name: convertinstancehostid
        in: query
        description: (only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: convertinstancepoolid
        in: query
        description: (only for importing VMs from VMware to KVM) optional - the temporary storage pool to perform the virt-v2v migration from VMware to KVM.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: datacentername
        in: query
        description: (only for importing VMs from VMware to KVM) Name of VMware datacenter.
        schema:
          type: string
          maxLength: 255
      - name: datadiskofferinglist
        in: query
        description: Datadisk Template to disk-offering mapping using keys disk and diskOffering. Map parameter. CloudStack expects it index-encoded as `datadiskofferinglist[0].key=k&datadiskofferinglist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: details
        in: query
        description: Used to specify the custom parameters. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: diskpath
        in: query
        description: path of the disk image
        schema:
          type: string
          maxLength: 255
      - name: displayname
        in: query
        description: The display name of the Instance
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Import Instance to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: existingvcenterid
        in: query
        description: (only for importing VMs from VMware to KVM) UUID of a linked existing vCenter
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: extraparams
        in: query
        description: (only for importing VMs from VMware to KVM) optional - extra parameters to be passed on the virt-v2v command, if allowed by the administrator
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.22'
      - name: forceconverttopool
        in: query
        description: (only for importing VMs from VMware to KVM) optional - if true, forces virt-v2v conversions to write directly on the provided storage pool (avoid using temporary conversion pool).
        schema:
          type: boolean
        x-cloudstack-since: '4.22'
      - name: forced
        in: query
        description: Instance is imported despite some of its NIC's MAC addresses are already present, in case the MAC address exists then a new MAC address is generated
        schema:
          type: boolean
      - name: forcemstoimportvmfiles
        in: query
        description: (only for importing VMs from VMware to KVM) optional - if true, forces MS to export OVF from VMware to temporary storage, else uses KVM Host if ovftool is available, falls back to MS if not.
        schema:
          type: boolean
      - name: host
        in: query
        description: the host name or IP address
        schema:
          type: string
          maxLength: 255
      - name: hostid
        in: query
        description: Host where local disk is located
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: hostip
        in: query
        description: (only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.
        schema:
          type: string
          maxLength: 255
      - name: hostname
        in: query
        description: The host name of the Instance
        schema:
          type: string
          maxLength: 255
      - name: importinstancehostid
        in: query
        description: (only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.19.2
      - name: migrateallowed
        in: query
        description: Instance and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool
        schema:
          type: boolean
      - name: networkid
        in: query
        description: the network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - updateNetwork
      - name: nicipaddresslist
        in: query
        description: VM NIC to ip address mapping using keys NIC, ip4Address. Map parameter. CloudStack expects it index-encoded as `nicipaddresslist[0].key=k&nicipaddresslist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: nicnetworklist
        in: query
        description: VM NIC to network id mapping using keys NIC and network. Map parameter. CloudStack expects it index-encoded as `nicnetworklist[0].key=k&nicnetworklist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: osid
        in: query
        description: (only for importing VMs from VMware to KVM) optional - the ID of the guest OS for the imported VM.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.22.1
      - name: password
        in: query
        description: the password for the host
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: Import Instance for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: storageid
        in: query
        description: Shared storage pool where disk is located
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: templateid
        in: query
        description: The ID of the Template for the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: temppath
        in: query
        description: Temp Path on external host for disk image copy
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: the username for the host
        schema:
          type: string
          maxLength: 255
      - name: usevddk
        in: query
        description: (only for importing VMs from VMware to KVM) optional - if true, uses VDDK on the KVM conversion host for converting the VM. This parameter is mutually exclusive with forcemstoimportvmfiles.
        schema:
          type: boolean
        x-cloudstack-since: 4.22.1
      - name: vcenter
        in: query
        description: (only for importing VMs from VMware to KVM) The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `importVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importvmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - importvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - importvmresponse
      x-cloudstack-command: importVm
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /importVolume:
    get:
      operationId: importVolume
      summary: Import an unmanaged volume from a storage pool on a host into CloudStack
      description: |-
        Import an unmanaged volume from a storage pool on a host into CloudStack

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: importVolume
          default: importVolume
      - $ref: '#/components/parameters/response'
      - name: path
        in: query
        description: the path of the volume
        required: true
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: the ID of the storage pool
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
      - name: account
        in: query
        description: an optional account for the volume. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: diskofferingid
        in: query
        description: the ID of the disk offering linked to the volume
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: domainid
        in: query
        description: import volume to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: name
        in: query
        description: the name of the volume. If not set, it will be set to the path of the volume.
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: import volume for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `importVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - importvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - importvolumeresponse
      x-cloudstack-command: importVolume
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.1
      x-cloudstack-related:
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /importVsphereStoragePolicies:
    get:
      operationId: importVsphereStoragePolicies
      summary: Import vSphere storage policies
      tags:
      - VsphereStoragePolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: importVsphereStoragePolicies
          default: importVsphereStoragePolicies
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: ID of the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `importVsphereStoragePolicies`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importvspherestoragepoliciesresponse:
                    oneOf:
                    - &id174
                      $ref: '#/components/schemas/VsphereStoragePolicy'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id174
                        - type: array
                          items: *id174
                required:
                - importvspherestoragepoliciesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  importvspherestoragepoliciesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - importvspherestoragepoliciesresponse
      x-cloudstack-command: importVsphereStoragePolicies
      x-cloudstack-async: false
      x-cloudstack-related:
      - listVsphereStoragePolicies
  /isAccountAllowedToCreateOfferingsWithTags:
    get:
      operationId: isAccountAllowedToCreateOfferingsWithTags
      summary: Return true if the specified account is allowed to create offerings with tags.
      tags:
      - AccountAllowedToCreateOfferingsWithTag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: isAccountAllowedToCreateOfferingsWithTags
          default: isAccountAllowedToCreateOfferingsWithTags
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Account UUID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAccount
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      responses:
        '200':
          description: Successful invocation of `isAccountAllowedToCreateOfferingsWithTags`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  isaccountallowedtocreateofferingswithtagsresponse:
                    oneOf:
                    - &id175
                      $ref: '#/components/schemas/AccountAllowedToCreateOfferingsWithTag'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id175
                        - type: array
                          items: *id175
                required:
                - isaccountallowedtocreateofferingswithtagsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  isaccountallowedtocreateofferingswithtagsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - isaccountallowedtocreateofferingswithtagsresponse
      x-cloudstack-command: isAccountAllowedToCreateOfferingsWithTags
      x-cloudstack-async: false
  /issueCertificate:
    get:
      operationId: issueCertificate
      summary: Issues a client certificate using configured or provided CA plugin
      description: |-
        Issues a client certificate using configured or provided CA plugin

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Certificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: issueCertificate
          default: issueCertificate
      - $ref: '#/components/parameters/response'
      - name: csr
        in: query
        description: The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered
        schema:
          type: string
          maxLength: 65535
      - name: domain
        in: query
        description: Comma separated list of domains, the certificate should be issued for. When csr is not provided, the first domain is used as a subject/CN
        schema:
          type: string
          maxLength: 255
      - name: duration
        in: query
        description: Certificate validity duration in number of days, when not provided the default configured value will be used
        schema:
          type: integer
          format: int32
      - name: ipaddress
        in: query
        description: Comma separated list of IP addresses, the certificate should be issued for
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: Name of the CA service provider, otherwise the default configured provider plugin will be used
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `issueCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  issuecertificateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - issuecertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  issuecertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - issuecertificateresponse
      x-cloudstack-command: issueCertificate
      x-cloudstack-async: true
      x-cloudstack-since: 4.11.0
      x-cloudstack-related:
      - listCaCertificate
      x-cloudstack-jobresult-schema: '#/components/schemas/IssueCertificateResult'
  /issueOutOfBandManagementPowerAction:
    get:
      operationId: issueOutOfBandManagementPowerAction
      summary: Initiates the specified power action to the host's out-of-band management interface
      description: |-
        Initiates the specified power action to the host's out-of-band management interface

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - OutOfBandManagementPowerAction
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: issueOutOfBandManagementPowerAction
          default: issueOutOfBandManagementPowerAction
      - $ref: '#/components/parameters/response'
      - name: action
        in: query
        description: 'Out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hostid
        in: query
        description: The ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      - name: timeout
        in: query
        description: Optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `issueOutOfBandManagementPowerAction`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  issueoutofbandmanagementpoweractionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - issueoutofbandmanagementpoweractionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  issueoutofbandmanagementpoweractionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - issueoutofbandmanagementpoweractionresponse
      x-cloudstack-command: issueOutOfBandManagementPowerAction
      x-cloudstack-async: true
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - changeOutOfBandManagementPassword
      - configureOutOfBandManagement
      - disableOutOfBandManagementForCluster
      - disableOutOfBandManagementForHost
      - enableOutOfBandManagementForCluster
      - enableOutOfBandManagementForHost
      x-cloudstack-jobresult-schema: '#/components/schemas/ChangeOutOfBandManagementPasswordResult'
  /ldapConfig:
    get:
      operationId: ldapConfig
      summary: (Deprecated, use addLdapConfiguration) Configure the LDAP context for this site.
      tags:
      - LdapConfig
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: ldapConfig
          default: ldapConfig
      - $ref: '#/components/parameters/response'
      - name: binddn
        in: query
        description: Specify the distinguished name of a user with the search permission on the directory.
        schema:
          type: string
          maxLength: 255
      - name: bindpass
        in: query
        description: Enter the password.
        schema:
          type: string
          maxLength: 255
      - name: hostname
        in: query
        description: 'Hostname or ip address of the ldap server eg: my.ldap.com'
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If true return current LDAP configuration
        schema:
          type: boolean
      - name: port
        in: query
        description: Specify the LDAP port if required, default is 389.
        schema:
          type: integer
          format: int32
      - name: queryfilter
        in: query
        description: You specify a query filter here, which narrows down the users, who can be part of this domain.
        schema:
          type: string
          maxLength: 255
      - name: searchbase
        in: query
        description: 'The search base defines the starting point for the search in the directory tree Example:  dc=cloud,dc=com.'
        schema:
          type: string
          maxLength: 255
      - name: ssl
        in: query
        description: Check Use SSL if the external LDAP server is configured for LDAP over SSL.
        schema:
          type: boolean
      - name: truststore
        in: query
        description: Enter the path to trust certificates store.
        schema:
          type: string
          maxLength: 255
      - name: truststorepass
        in: query
        description: Enter the password for trust store.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `ldapConfig`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ldapconfigresponse:
                    oneOf:
                    - &id176
                      $ref: '#/components/schemas/LdapConfigResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id176
                        - type: array
                          items: *id176
                required:
                - ldapconfigresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ldapconfigresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - ldapconfigresponse
      x-cloudstack-command: ldapConfig
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - ldapRemove
  /ldapCreateAccount:
    get:
      operationId: ldapCreateAccount
      summary: Creates an account from an LDAP user
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: ldapCreateAccount
          default: ldapCreateAccount
      - $ref: '#/components/parameters/response'
      - name: username
        in: query
        description: Unique username.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: Creates the user under the specified account. If no account is specified, the username will be used as the account name.
        schema:
          type: string
          maxLength: 255
      - name: accountdetails
        in: query
        description: Details for account used to store specific parameters. Map parameter. CloudStack expects it index-encoded as `accountdetails[0].key=k&accountdetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: accountid
        in: query
        description: Account UUID, required for adding account from external provisioning system
        schema:
          type: string
          maxLength: 255
      - name: accounttype
        in: query
        description: Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin
        schema:
          type: integer
          format: int32
      - name: domainid
        in: query
        description: Creates the user under the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: networkdomain
        in: query
        description: Network domain for the account's networks
        schema:
          type: string
          maxLength: 255
      - name: roleid
        in: query
        description: Creates the account under the specified role.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - importRole
        - listRoles
        - updateRole
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
        schema:
          type: string
          maxLength: 255
      - name: userid
        in: query
        description: User UUID, required for adding account from external provisioning system
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `ldapCreateAccount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ldapcreateaccountresponse:
                    oneOf:
                    - &id177
                      $ref: '#/components/schemas/Account'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id177
                        - type: array
                          items: *id177
                required:
                - ldapcreateaccountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ldapcreateaccountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - ldapcreateaccountresponse
      x-cloudstack-command: ldapCreateAccount
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - createAccount
      - disableAccount
      - enableAccount
      - listAccounts
      - lockAccount
      - markDefaultZoneForAccount
      - updateAccount
  /ldapRemove:
    get:
      operationId: ldapRemove
      summary: (Deprecated , use deleteLdapConfiguration) Remove the LDAP context for this site.
      tags:
      - LdapRemove
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: ldapRemove
          default: ldapRemove
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `ldapRemove`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ldapremoveresponse:
                    oneOf:
                    - &id178
                      $ref: '#/components/schemas/LdapConfigResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id178
                        - type: array
                          items: *id178
                required:
                - ldapremoveresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  ldapremoveresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - ldapremoveresponse
      x-cloudstack-command: ldapRemove
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.1
  /linkAccountToLdap:
    get:
      operationId: linkAccountToLdap
      summary: Link a cloudstack account to a group or OU in ldap
      tags:
      - AccountToLdap
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: linkAccountToLdap
          default: linkAccountToLdap
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Name of the account, it will be created if it does not exist
        required: true
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The id of the domain that is to contain the linked account.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: ldapdomain
        in: query
        description: Name of the group or OU in LDAP
        required: true
        schema:
          type: string
          maxLength: 255
      - name: accounttype
        in: query
        description: Type of the account to auto import. Specify 0 for user and 2 for domain admin
        schema:
          type: integer
          format: int32
      - name: admin
        in: query
        description: Domain admin username in LDAP
        schema:
          type: string
          maxLength: 255
      - name: roleid
        in: query
        description: Creates the account under the specified role.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.19.1
        x-cloudstack-related:
        - createRole
        - importRole
        - listRoles
        - updateRole
      - name: type
        in: query
        description: Type of the LDAP name. GROUP or OU, defaults to GROUP
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `linkAccountToLdap`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkaccounttoldapresponse:
                    oneOf:
                    - &id179
                      $ref: '#/components/schemas/LinkAccountToLdapResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id179
                        - type: array
                          items: *id179
                required:
                - linkaccounttoldapresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkaccounttoldapresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - linkaccounttoldapresponse
      x-cloudstack-command: linkAccountToLdap
      x-cloudstack-async: false
      x-cloudstack-since: 4.11.0
  /linkDomainToLdap:
    get:
      operationId: linkDomainToLdap
      summary: Link an existing Cloudstack domain to group or OU in ldap
      tags:
      - DomainToLdap
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: linkDomainToLdap
          default: linkDomainToLdap
      - $ref: '#/components/parameters/response'
      - name: accounttype
        in: query
        description: Type of the account to auto import. Specify 0 for user and 2 for domain admin
        required: true
        schema:
          type: integer
          format: int32
      - name: domainid
        in: query
        description: The id of the domain which has to be linked to LDAP.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: ldapdomain
        in: query
        description: Name of the GROUP or OU in LDAP
        required: true
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: Type of the ldap name. GROUP or OU
        required: true
        schema:
          type: string
          maxLength: 255
      - name: admin
        in: query
        description: Domain admin username in LDAP
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `linkDomainToLdap`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkdomaintoldapresponse:
                    oneOf:
                    - &id180
                      $ref: '#/components/schemas/LinkAccountToLdapResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id180
                        - type: array
                          items: *id180
                required:
                - linkdomaintoldapresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkdomaintoldapresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - linkdomaintoldapresponse
      x-cloudstack-command: linkDomainToLdap
      x-cloudstack-async: false
      x-cloudstack-since: 4.6.0
      x-cloudstack-related:
      - linkAccountToLdap
  /linkUserDataToTemplate:
    get:
      operationId: linkUserDataToTemplate
      summary: Link or unlink a userdata to a Template.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: linkUserDataToTemplate
          default: linkUserDataToTemplate
      - $ref: '#/components/parameters/response'
      - name: isoid
        in: query
        description: The ID of the ISO for the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: templateid
        in: query
        description: The ID of the Template for the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: userdataid
        in: query
        description: The ID of the userdata that has to be linked to Template/ISO. If not provided existing userdata will be unlinked from the Template/ISO
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: userdatapolicy
        in: query
        description: An optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `linkUserDataToTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkuserdatatotemplateresponse:
                    oneOf:
                    - &id181
                      $ref: '#/components/schemas/Template'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id181
                        - type: array
                          items: *id181
                required:
                - linkuserdatatotemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  linkuserdatatotemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - linkuserdatatotemplateresponse
      x-cloudstack-command: linkUserDataToTemplate
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateVnfTemplate
  /listASNRanges:
    get:
      operationId: listASNRanges
      summary: List Autonomous Systems Number Ranges
      tags:
      - ASNRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listASNRanges
          default: listASNRanges
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: the zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `listASNRanges`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listasnrangesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id182
                        $ref: '#/components/schemas/ASNRange'
                      - type: array
                        items: *id182
                required:
                - listasnrangesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listasnrangesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listasnrangesresponse
      x-cloudstack-command: listASNRanges
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /listASNumbers:
    get:
      operationId: listASNumbers
      summary: List Autonomous Systems Numbers
      tags:
      - ASNumber
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listASNumbers
          default: listASNumbers
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: account name
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - createAccount
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      - name: asnrangeid
        in: query
        description: the AS Number range ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createASNRange
        - listASNRanges
      - name: asnumber
        in: query
        description: AS number
        schema:
          type: integer
          format: int32
        x-cloudstack-related:
        - listASNumbers
      - name: domainid
        in: query
        description: domain id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: isallocated
        in: query
        description: to indicate if the AS number is allocated to any network
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: the network id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: vpcid
        in: query
        description: the vpc id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      - name: zoneid
        in: query
        description: the zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listASNumbers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listasnumbersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id183
                        $ref: '#/components/schemas/ASNumber'
                      - type: array
                        items: *id183
                required:
                - listasnumbersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listasnumbersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listasnumbersresponse
      x-cloudstack-command: listASNumbers
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /listAccounts:
    get:
      operationId: listAccounts
      summary: Lists Accounts and provides detailed Account information for listed Accounts
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAccounts
          default: listAccounts
      - $ref: '#/components/parameters/response'
      - name: accounttype
        in: query
        description: List Accounts by Account type. Valid Account types are 1 (admin), 2 (domain-admin), and 0 (user).
        schema:
          type: integer
          format: int32
      - name: apikeyaccess
        in: query
        description: List accounts by the Api key access value
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1.0
      - name: details
        in: query
        description: Comma separated list of account details requested, value can be a list of [ all, resource, min]. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: List Account by Account ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      - name: iscleanuprequired
        in: query
        description: List accounts by cleanuprequired attribute (values are true or false)
        schema:
          type: boolean
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: List account by account name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showicon
        in: query
        description: Flag to display the resource icon for accounts
        schema:
          type: boolean
      - name: state
        in: query
        description: List accounts by state. Valid states are enabled, disabled, and locked.
        schema:
          type: string
          maxLength: 255
      - name: tag
        in: query
        description: Tag for resource type to return usage
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      responses:
        '200':
          description: Successful invocation of `listAccounts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listaccountsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      account:
                        type: array
                        items:
                          $ref: '#/components/schemas/Account'
                    additionalProperties: true
                required:
                - listaccountsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listaccountsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listaccountsresponse
      x-cloudstack-command: listAccounts
      x-cloudstack-async: false
      x-cloudstack-related:
      - disableAccount
      - enableAccount
      - listAccounts
      - lockAccount
      - markDefaultZoneForAccount
      - updateAccount
  /listAffectedVmsForStorageScopeChange:
    get:
      operationId: listAffectedVmsForStorageScopeChange
      summary: List user and system VMs that need to be stopped and destroyed respectively for changing the scope of the storage pool from Zone to Cluster.
      tags:
      - AffectedVmsForStorageScopeChange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAffectedVmsForStorageScopeChange
          default: listAffectedVmsForStorageScopeChange
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: the Id of the cluster the scope of the storage pool is being changed to
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: storageid
        in: query
        description: the Id of the storage pool on which change scope operation is being done
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listAffectedVmsForStorageScopeChange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listaffectedvmsforstoragescopechangeresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id184
                        $ref: '#/components/schemas/AffectedVmsForStorageScopeChange'
                      - type: array
                        items: *id184
                required:
                - listaffectedvmsforstoragescopechangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listaffectedvmsforstoragescopechangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listaffectedvmsforstoragescopechangeresponse
      x-cloudstack-command: listAffectedVmsForStorageScopeChange
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.1
  /listAffinityGroupTypes:
    get:
      operationId: listAffinityGroupTypes
      summary: Lists affinity group types available
      tags:
      - AffinityGroupType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAffinityGroupTypes
          default: listAffinityGroupTypes
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listAffinityGroupTypes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listaffinitygrouptypesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      affinityGroupType:
                        type: array
                        items:
                          $ref: '#/components/schemas/AffinityGroupType'
                    additionalProperties: true
                required:
                - listaffinitygrouptypesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listaffinitygrouptypesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listaffinitygrouptypesresponse
      x-cloudstack-command: listAffinityGroupTypes
      x-cloudstack-async: false
  /listAffinityGroups:
    get:
      operationId: listAffinityGroups
      summary: Lists affinity groups
      tags:
      - AffinityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAffinityGroups
          default: listAffinityGroups
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: List the affinity group by the ID provided
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAffinityGroup
        - listAffinityGroups
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Lists affinity groups by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: type
        in: query
        description: Lists affinity groups by type
        schema:
          type: string
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: Lists affinity groups by Instance ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `listAffinityGroups`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listaffinitygroupsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id185
                        $ref: '#/components/schemas/AffinityGroup'
                      - type: array
                        items: *id185
                required:
                - listaffinitygroupsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listaffinitygroupsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listaffinitygroupsresponse
      x-cloudstack-command: listAffinityGroups
      x-cloudstack-async: false
      x-cloudstack-related:
      - createAffinityGroup
  /listAlertTypes:
    get:
      operationId: listAlertTypes
      summary: Lists all alerts types
      tags:
      - AlertType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAlertTypes
          default: listAlertTypes
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `listAlertTypes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listalerttypesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      alerttype:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListAlertTypesResult'
                    additionalProperties: true
                required:
                - listalerttypesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listalerttypesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listalerttypesresponse
      x-cloudstack-command: listAlertTypes
      x-cloudstack-async: false
      x-cloudstack-related:
      - listAlerts
  /listAlerts:
    get:
      operationId: listAlerts
      summary: Lists all alerts.
      tags:
      - Alert
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAlerts
          default: listAlerts
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the alert
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listAlerts
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List by alert name
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.3'
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: type
        in: query
        description: List by alert type
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listAlerts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listalertsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      alert:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListAlertTypesResult'
                    additionalProperties: true
                required:
                - listalertsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listalertsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listalertsresponse
      x-cloudstack-command: listAlerts
      x-cloudstack-async: false
  /listAnnotations:
    get:
      operationId: listAnnotations
      summary: Lists annotations.
      tags:
      - Annotation
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAnnotations
          default: listAnnotations
      - $ref: '#/components/parameters/response'
      - name: annotationfilter
        in: query
        description: 'Possible values are "self" and "all". * self : annotations that have been created by the calling user. * all : all the annotations the calling user can access'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.16.0
      - name: entityid
        in: query
        description: The ID of the entity for which to show annotations
        schema:
          type: string
          maxLength: 255
      - name: entitytype
        in: query
        description: The entity type
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the annotation
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: userid
        in: query
        description: 'Optional: The ID of the user of the annotation'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.16.0
      responses:
        '200':
          description: Successful invocation of `listAnnotations`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listannotationsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id186
                        $ref: '#/components/schemas/Annotation'
                      - type: array
                        items: *id186
                required:
                - listannotationsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listannotationsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listannotationsresponse
      x-cloudstack-command: listAnnotations
      x-cloudstack-async: false
      x-cloudstack-since: '4.11'
      x-cloudstack-related:
      - addAnnotation
  /listApis:
    get:
      operationId: listApis
      summary: Lists all available APIs on the server, provided by the API Discovery plugin
      tags:
      - Api
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listApis
          default: listApis
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: API name
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listApis`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listapisresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      api:
                        type: array
                        items:
                          $ref: '#/components/schemas/Api'
                    additionalProperties: true
                required:
                - listapisresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listapisresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listapisresponse
      x-cloudstack-command: listApis
      x-cloudstack-async: false
      x-cloudstack-since: 4.1.0
  /listAsyncJobs:
    get:
      operationId: listAsyncJobs
      summary: Lists all pending asynchronous jobs for the Account.
      tags:
      - AsyncJob
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAsyncJobs
          default: listAsyncJobs
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: managementserverid
        in: query
        description: The id of the management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.19'
        x-cloudstack-related:
        - listManagementServers
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: resourceid
        in: query
        description: the ID of the resource associated with the job
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.22.1
      - name: resourcetype
        in: query
        description: the type of the resource associated with the job
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.22.1
      - name: startdate
        in: query
        description: The start date of the async job (use format "yyyy-MM-dd'T'HH:mm:ss'+'SSSS"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listAsyncJobs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listasyncjobsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id187
                        $ref: '#/components/schemas/ListAsyncJobsResult'
                      - type: array
                        items: *id187
                required:
                - listasyncjobsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listasyncjobsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listasyncjobsresponse
      x-cloudstack-command: listAsyncJobs
      x-cloudstack-async: false
      x-cloudstack-related:
      - migrateVolumesToKMS
      - queryAsyncJobResult
      - rotateKMSKey
  /listAutoScalePolicies:
    get:
      operationId: listAutoScalePolicies
      summary: Lists autoscale policies.
      tags:
      - AutoScalePolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAutoScalePolicies
          default: listAutoScalePolicies
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: action
        in: query
        description: The action to be executed if all the conditions evaluate to true for the specified duration.
        schema:
          type: string
          maxLength: 255
      - name: conditionid
        in: query
        description: The ID of the condition of the policy
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: The ID of the autoscale policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listAutoScalePolicies
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the autoscale policy
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: vmgroupid
        in: query
        description: The ID of the autoscale Instance group
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listAutoScalePolicies`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listautoscalepoliciesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id188
                        $ref: '#/components/schemas/AutoScalePolicy'
                      - type: array
                        items: *id188
                required:
                - listautoscalepoliciesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listautoscalepoliciesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listautoscalepoliciesresponse
      x-cloudstack-command: listAutoScalePolicies
      x-cloudstack-async: false
  /listAutoScaleVmGroups:
    get:
      operationId: listAutoScaleVmGroups
      summary: Lists autoscale Instance groups.
      tags:
      - AutoScaleVmGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAutoScaleVmGroups
          default: listAutoScaleVmGroups
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: The ID of the autoscale Instance group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - enableAutoScaleVmGroup
        - listAutoScaleVmGroups
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: lbruleid
        in: query
        description: The ID of the loadbalancer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updatePortForwardingRule
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the autoscale vmgroup
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: policyid
        in: query
        description: The ID of the policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listAutoScalePolicies
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
      - name: vmprofileid
        in: query
        description: The ID of the profile
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAutoScaleVmProfile
        - listAutoScaleVmProfiles
        - updateAutoScaleVmProfile
      - name: zoneid
        in: query
        description: The availability zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listAutoScaleVmGroups`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listautoscalevmgroupsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id189
                        $ref: '#/components/schemas/AutoScaleVmGroup'
                      - type: array
                        items: *id189
                required:
                - listautoscalevmgroupsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listautoscalevmgroupsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listautoscalevmgroupsresponse
      x-cloudstack-command: listAutoScaleVmGroups
      x-cloudstack-async: false
      x-cloudstack-related:
      - enableAutoScaleVmGroup
  /listAutoScaleVmProfiles:
    get:
      operationId: listAutoScaleVmProfiles
      summary: Lists autoscale Instance profiles.
      tags:
      - AutoScaleVmProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listAutoScaleVmProfiles
          default: listAutoScaleVmProfiles
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: The ID of the autoscale Instance profile
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listAutoScaleVmProfiles
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: otherdeployparams
        in: query
        description: The otherdeployparameters of the autoscale Instance profile
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: serviceofferingid
        in: query
        description: List profiles by service offering id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: templateid
        in: query
        description: The templateid of the autoscale Instance profile
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: zoneid
        in: query
        description: Availability zone for the auto deployed Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listAutoScaleVmProfiles`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listautoscalevmprofilesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id190
                        $ref: '#/components/schemas/AutoScaleVmProfile'
                      - type: array
                        items: *id190
                required:
                - listautoscalevmprofilesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listautoscalevmprofilesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listautoscalevmprofilesresponse
      x-cloudstack-command: listAutoScaleVmProfiles
      x-cloudstack-async: false
  /listBackupOfferings:
    get:
      operationId: listBackupOfferings
      summary: Lists backup offerings
      tags:
      - BackupOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBackupOfferings
          default: listBackupOfferings
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: The backup offering ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createBackupOffering
        - listBackupOfferings
        - updateBackupOffering
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listBackupOfferings`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupofferingsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id191
                        $ref: '#/components/schemas/BackupOffering'
                      - type: array
                        items: *id191
                required:
                - listbackupofferingsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupofferingsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbackupofferingsresponse
      x-cloudstack-command: listBackupOfferings
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
      x-cloudstack-related:
      - createBackupOffering
      - updateBackupOffering
  /listBackupProviderOfferings:
    get:
      operationId: listBackupProviderOfferings
      summary: Lists external backup offerings of the provider
      tags:
      - BackupProviderOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBackupProviderOfferings
          default: listBackupProviderOfferings
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listBackupProviderOfferings`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupproviderofferingsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id192
                        $ref: '#/components/schemas/BackupOffering'
                      - type: array
                        items: *id192
                required:
                - listbackupproviderofferingsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupproviderofferingsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbackupproviderofferingsresponse
      x-cloudstack-command: listBackupProviderOfferings
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
      x-cloudstack-related:
      - cloneBackupOffering
      - createBackupOffering
      - importBackupOffering
      - listBackupOfferings
      - updateBackupOffering
  /listBackupProviders:
    get:
      operationId: listBackupProviders
      summary: Lists Backup and Recovery providers
      tags:
      - BackupProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBackupProviders
          default: listBackupProviders
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: List Backup and Recovery provider by name
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listBackupProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      providers:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListBackupProvidersResult'
                    additionalProperties: true
                required:
                - listbackupprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbackupprovidersresponse
      x-cloudstack-command: listBackupProviders
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
  /listBackupRepositories:
    get:
      operationId: listBackupRepositories
      summary: Lists all backup repositories
      tags:
      - BackupRepository
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBackupRepositories
          default: listBackupRepositories
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the backup repository
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBackupRepository
        - listBackupRepositories
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: name of the backup repository
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: provider
        in: query
        description: the backup repository provider
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: ID of the zone where the backup repository is to be added
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listBackupRepositories`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackuprepositoriesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id193
                        $ref: '#/components/schemas/BackupRepository'
                      - type: array
                        items: *id193
                required:
                - listbackuprepositoriesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackuprepositoriesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbackuprepositoriesresponse
      x-cloudstack-command: listBackupRepositories
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - addBackupRepository
  /listBackupSchedule:
    get:
      operationId: listBackupSchedule
      summary: List backup schedule of an Instance
      tags:
      - BackupSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBackupSchedule
          default: listBackupSchedule
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: the ID of the backup schedule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.22.0
        x-cloudstack-related:
        - listBackupSchedule
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: ID of the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `listBackupSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupscheduleresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id194
                        $ref: '#/components/schemas/BackupSchedule'
                      - type: array
                        items: *id194
                required:
                - listbackupscheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupscheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbackupscheduleresponse
      x-cloudstack-command: listBackupSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
  /listBackupServiceJobs:
    get:
      operationId: listBackupServiceJobs
      summary: List backup service jobs
      tags:
      - BackupServiceJob
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBackupServiceJobs
          default: listBackupServiceJobs
      - $ref: '#/components/parameters/response'
      - name: backupid
        in: query
        description: List jobs for the given backup.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateBackupSchedule
      - name: executing
        in: query
        description: List executing jobs.
        schema:
          type: boolean
      - name: hostid
        in: query
        description: List jobs in the given host. When passing this parameter, only jobs that are currently executing will be returned.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: id
        in: query
        description: List only job with given ID.
        schema:
          type: integer
          format: int64
        x-cloudstack-related:
        - listBackupServiceJobs
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: scheduled
        in: query
        description: List scheduled jobs.
        schema:
          type: boolean
      - name: type
        in: query
        description: List jobs with the given type. Accepted values are StartCompression, FinalizeCompression and BackupValidation.
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: List jobs in the given zone.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listBackupServiceJobs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupservicejobsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id195
                        $ref: '#/components/schemas/BackupServiceJob'
                      - type: array
                        items: *id195
                required:
                - listbackupservicejobsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupservicejobsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbackupservicejobsresponse
      x-cloudstack-command: listBackupServiceJobs
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /listBackups:
    get:
      operationId: listBackups
      summary: Lists Instance backups
      tags:
      - Backup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBackups
          default: listBackups
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: backupofferingid
        in: query
        description: list backups by backup offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - cloneBackupOffering
        - createBackupOffering
        - importBackupOffering
        - listBackupOfferings
        - listBackupProviderOfferings
        - updateBackupOffering
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: ID of the backup
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listBackups
        - updateBackupSchedule
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: listvmdetails
        in: query
        description: list backups with VM details
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: name
        in: query
        description: list backups by name
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: status
        in: query
        description: list backups by status
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: virtualmachineid
        in: query
        description: ID of the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: zoneid
        in: query
        description: List backups by zone id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listBackups`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id196
                        $ref: '#/components/schemas/ListBackupsResult'
                      - type: array
                        items: *id196
                required:
                - listbackupsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbackupsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbackupsresponse
      x-cloudstack-command: listBackups
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
      x-cloudstack-related:
      - updateBackupSchedule
  /listBaremetalDhcp:
    get:
      operationId: listBaremetalDhcp
      summary: List baremetal dhcp servers
      tags:
      - BaremetalDhcp
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBaremetalDhcp
          default: listBaremetalDhcp
      - $ref: '#/components/parameters/response'
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: dhcpservertype
        in: query
        description: Type of DHCP device
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: DHCP server device ID
        schema:
          type: integer
          format: int64
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listBaremetalDhcp`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbaremetaldhcpresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id197
                        $ref: '#/components/schemas/BaremetalDhcp'
                      - type: array
                        items: *id197
                required:
                - listbaremetaldhcpresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbaremetaldhcpresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbaremetaldhcpresponse
      x-cloudstack-command: listBaremetalDhcp
      x-cloudstack-async: false
  /listBaremetalPxeServers:
    get:
      operationId: listBaremetalPxeServers
      summary: List baremetal pxe server
      tags:
      - BaremetalPxeServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBaremetalPxeServers
          default: listBaremetalPxeServers
      - $ref: '#/components/parameters/response'
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: id
        in: query
        description: Pxe server device ID
        schema:
          type: integer
          format: int64
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listBaremetalPxeServers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbaremetalpxeserversresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id198
                        $ref: '#/components/schemas/BaremetalPxeServer'
                      - type: array
                        items: *id198
                required:
                - listbaremetalpxeserversresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbaremetalpxeserversresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbaremetalpxeserversresponse
      x-cloudstack-command: listBaremetalPxeServers
      x-cloudstack-async: false
  /listBaremetalRct:
    get:
      operationId: listBaremetalRct
      summary: List baremetal rack configuration
      tags:
      - BaremetalRct
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBaremetalRct
          default: listBaremetalRct
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listBaremetalRct`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbaremetalrctresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id199
                        $ref: '#/components/schemas/BaremetalRct'
                      - type: array
                        items: *id199
                required:
                - listbaremetalrctresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbaremetalrctresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbaremetalrctresponse
      x-cloudstack-command: listBaremetalRct
      x-cloudstack-async: false
      x-cloudstack-related:
      - addBaremetalRct
  /listBgpPeers:
    get:
      operationId: listBgpPeers
      summary: Lists Bgp Peers.
      tags:
      - BgpPeer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBgpPeers
          default: listBgpPeers
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: asnumber
        in: query
        description: AS number of the Bgp Peer.
        schema:
          type: integer
          format: int64
      - name: domainid
        in: query
        description: the domain ID which the Bgp Peer is dedicated to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: UUID of the Bgp Peer.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listBgpPeers
        - releaseBgpPeer
      - name: isdedicated
        in: query
        description: Lists only dedicated or non-dedicated Bgp Peers. If not set, lists all dedicated and non-dedicated BGP peers the domain/account can access.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: project who which the Bgp Peer is dedicated to
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: zoneid
        in: query
        description: UUID of zone to which the Bgp Peer belongs to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listBgpPeers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbgppeersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id200
                        $ref: '#/components/schemas/BgpPeer'
                      - type: array
                        items: *id200
                required:
                - listbgppeersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbgppeersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbgppeersresponse
      x-cloudstack-command: listBgpPeers
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - releaseBgpPeer
  /listBigSwitchBcfDevices:
    get:
      operationId: listBigSwitchBcfDevices
      summary: Lists BigSwitch BCF Controller devices
      tags:
      - BigSwitchBcfDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBigSwitchBcfDevices
          default: listBigSwitchBcfDevices
      - $ref: '#/components/parameters/response'
      - name: bcfdeviceid
        in: query
        description: Bigswitch BCF controller device ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listBigSwitchBcfDevices
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listBigSwitchBcfDevices`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbigswitchbcfdevicesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id201
                        $ref: '#/components/schemas/BigSwitchBcfDevice'
                      - type: array
                        items: *id201
                required:
                - listbigswitchbcfdevicesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbigswitchbcfdevicesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbigswitchbcfdevicesresponse
      x-cloudstack-command: listBigSwitchBcfDevices
      x-cloudstack-async: false
      x-cloudstack-since: 4.6.0
  /listBrocadeVcsDeviceNetworks:
    get:
      operationId: listBrocadeVcsDeviceNetworks
      summary: Lists network that are using a brocade vcs switch
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBrocadeVcsDeviceNetworks
          default: listBrocadeVcsDeviceNetworks
      - $ref: '#/components/parameters/response'
      - name: vcsdeviceid
        in: query
        description: Brocade vcs switch ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listBrocadeVcsDeviceNetworks`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbrocadevcsdevicenetworksresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id202
                        $ref: '#/components/schemas/Network'
                      - type: array
                        items: *id202
                required:
                - listbrocadevcsdevicenetworksresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbrocadevcsdevicenetworksresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbrocadevcsdevicenetworksresponse
      x-cloudstack-command: listBrocadeVcsDeviceNetworks
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetwork
      - listNetworks
      - listPaloAltoFirewallNetworks
      - migrateNetwork
      - updateNetwork
  /listBrocadeVcsDevices:
    get:
      operationId: listBrocadeVcsDevices
      summary: Lists Brocade VCS Switches
      tags:
      - BrocadeVcsDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBrocadeVcsDevices
          default: listBrocadeVcsDevices
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: vcsdeviceid
        in: query
        description: Brocade VCS switch ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listBrocadeVcsDevices
      responses:
        '200':
          description: Successful invocation of `listBrocadeVcsDevices`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbrocadevcsdevicesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id203
                        $ref: '#/components/schemas/BrocadeVcsDevice'
                      - type: array
                        items: *id203
                required:
                - listbrocadevcsdevicesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbrocadevcsdevicesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbrocadevcsdevicesresponse
      x-cloudstack-command: listBrocadeVcsDevices
      x-cloudstack-async: false
  /listBuckets:
    get:
      operationId: listBuckets
      summary: Lists all Buckets.
      tags:
      - Bucket
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listBuckets
          default: listBuckets
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: the ID of the bucket
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listBuckets
      - name: ids
        in: query
        description: the IDs of the Buckets, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listBuckets
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: the name of the bucket
        schema:
          type: string
          maxLength: 255
      - name: objectstorageid
        in: query
        description: the ID of the object storage pool, available to ROOT admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `listBuckets`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbucketsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id204
                        $ref: '#/components/schemas/Bucket'
                      - type: array
                        items: *id204
                required:
                - listbucketsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listbucketsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listbucketsresponse
      x-cloudstack-command: listBuckets
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /listCAProviders:
    get:
      operationId: listCAProviders
      summary: Lists available certificate authority providers in CloudStack
      tags:
      - CAProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCAProviders
          default: listCAProviders
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: List CA service provider by name
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listCAProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcaprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      caprovider:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListBackupProvidersResult'
                    additionalProperties: true
                required:
                - listcaprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcaprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listcaprovidersresponse
      x-cloudstack-command: listCAProviders
      x-cloudstack-async: false
      x-cloudstack-since: 4.11.0
  /listCaCertificate:
    get:
      operationId: listCaCertificate
      summary: Lists the CA public certificate(s) as support by the configured/provided CA plugin
      tags:
      - Certificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCaCertificate
          default: listCaCertificate
      - $ref: '#/components/parameters/response'
      - name: provider
        in: query
        description: Name of the CA service provider, otherwise the default configured provider plugin will be used
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listCaCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcacertificateresponse:
                    type: object
                    properties:
                      cacertificates:
                        $ref: '#/components/schemas/IssueCertificateResult'
                    additionalProperties: true
                required:
                - listcacertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcacertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listcacertificateresponse
      x-cloudstack-command: listCaCertificate
      x-cloudstack-async: false
      x-cloudstack-since: 4.11.0
  /listCapabilities:
    get:
      operationId: listCapabilities
      summary: Lists capabilities
      tags:
      - Capability
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCapabilities
          default: listCapabilities
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: the domain for listing capabilities.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      responses:
        '200':
          description: Successful invocation of `listCapabilities`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcapabilitiesresponse:
                    type: object
                    properties:
                      capability:
                        $ref: '#/components/schemas/Capability2'
                    additionalProperties: true
                required:
                - listcapabilitiesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcapabilitiesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listcapabilitiesresponse
      x-cloudstack-command: listCapabilities
      x-cloudstack-async: false
  /listCapacity:
    get:
      operationId: listCapacity
      summary: Lists all the system wide capacities.
      tags:
      - Capacity
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCapacity
          default: listCapacity
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: Lists capacity by the Cluster ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 3.0.0
      - name: fetchlatest
        in: query
        description: Recalculate capacities and fetch the latest
        schema:
          type: boolean
        x-cloudstack-since: 3.0.0
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: Lists capacity by the Pod ID
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: sortby
        in: query
        description: 'Sort the results. Available values: Usage'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 3.0.0
      - name: tag
        in: query
        description: Tag for the resource type
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: type
        in: query
        description: Lists capacity by type* CAPACITY_TYPE_MEMORY = 0* CAPACITY_TYPE_CPU = 1* CAPACITY_TYPE_STORAGE = 2* CAPACITY_TYPE_STORAGE_ALLOCATED = 3* CAPACITY_TYPE_VIRTUAL_NETWORK_PUBLIC_IP = 4* CAPACITY_TYPE_PRIVATE_IP = 5* CAPACITY_TYPE_SECONDARY_STORAGE = 6* CAPACITY_TYPE_VLAN = 7* CAPACITY_TYPE_DIRECT_ATTACHED_PUBLIC_IP = 8* CAPACITY_TYPE_LOCAL_STORAGE = 9* CAPACITY_TYPE_GPU = 19* CAPACITY_TYPE_CPU_CORE = 90.
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: Lists capacity by the Zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listCapacity`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcapacityresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      capacity:
                        type: array
                        items:
                          $ref: '#/components/schemas/Capacity2'
                    additionalProperties: true
                required:
                - listcapacityresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcapacityresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listcapacityresponse
      x-cloudstack-command: listCapacity
      x-cloudstack-async: false
  /listCiscoAsa1000vResources:
    get:
      operationId: listCiscoAsa1000vResources
      summary: Lists Cisco ASA 1000v appliances
      tags:
      - CiscoAsa1000vResource
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCiscoAsa1000vResources
          default: listCiscoAsa1000vResources
      - $ref: '#/components/parameters/response'
      - name: hostname
        in: query
        description: Hostname or ip address of the Cisco ASA 1000v appliance.
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: resourceid
        in: query
        description: Cisco ASA 1000v resource ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCiscoAsa1000vResource
        - listCiscoAsa1000vResources
      responses:
        '200':
          description: Successful invocation of `listCiscoAsa1000vResources`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listciscoasa1000vresourcesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id205
                        $ref: '#/components/schemas/CiscoAsa1000vResource'
                      - type: array
                        items: *id205
                required:
                - listciscoasa1000vresourcesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listciscoasa1000vresourcesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listciscoasa1000vresourcesresponse
      x-cloudstack-command: listCiscoAsa1000vResources
      x-cloudstack-async: false
      x-cloudstack-related:
      - addCiscoAsa1000vResource
  /listCiscoNexusVSMs:
    get:
      operationId: listCiscoNexusVSMs
      summary: Retrieves a Cisco Nexus 1000v Virtual Switch Manager device associated with a Cluster
      tags:
      - CiscoNexusVSM
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCiscoNexusVSMs
          default: listCiscoNexusVSMs
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listCiscoNexusVSMs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcisconexusvsmsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id206
                        $ref: '#/components/schemas/CiscoNexusVSM'
                      - type: array
                        items: *id206
                required:
                - listcisconexusvsmsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcisconexusvsmsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listcisconexusvsmsresponse
      x-cloudstack-command: listCiscoNexusVSMs
      x-cloudstack-async: false
  /listCiscoVnmcResources:
    get:
      operationId: listCiscoVnmcResources
      summary: Lists Cisco VNMC controllers
      tags:
      - CiscoVnmcResource
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCiscoVnmcResources
          default: listCiscoVnmcResources
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: resourceid
        in: query
        description: Cisco VNMC resource ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listCiscoVnmcResources
      responses:
        '200':
          description: Successful invocation of `listCiscoVnmcResources`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listciscovnmcresourcesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id207
                        $ref: '#/components/schemas/CiscoAsa1000vResource'
                      - type: array
                        items: *id207
                required:
                - listciscovnmcresourcesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listciscovnmcresourcesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listciscovnmcresourcesresponse
      x-cloudstack-command: listCiscoVnmcResources
      x-cloudstack-async: false
  /listClusterDrsPlan:
    get:
      operationId: listClusterDrsPlan
      summary: List DRS plans for a clusters
      tags:
      - ClusterDrsPlan
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listClusterDrsPlan
          default: listClusterDrsPlan
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: ID of the cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - listClusters
        - updateCluster
      - name: id
        in: query
        description: ID of the drs plan
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - executeClusterDrsPlan
        - generateClusterDrsPlan
        - listClusterDrsPlan
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listClusterDrsPlan`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listclusterdrsplanresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id208
                        $ref: '#/components/schemas/ClusterDrsPlan'
                      - type: array
                        items: *id208
                required:
                - listclusterdrsplanresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listclusterdrsplanresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listclusterdrsplanresponse
      x-cloudstack-command: listClusterDrsPlan
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - executeClusterDrsPlan
      - generateClusterDrsPlan
  /listClusters:
    get:
      operationId: listClusters
      summary: Lists clusters.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listClusters
          default: listClusters
      - $ref: '#/components/parameters/response'
      - name: allocationstate
        in: query
        description: Lists clusters by allocation state
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: CPU arch of the clusters
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: clustertype
        in: query
        description: Lists clusters by cluster type
        schema:
          type: string
          maxLength: 255
      - name: hypervisor
        in: query
        description: Lists clusters by hypervisor type
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: Lists clusters by the cluster ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - listClusters
        - updateCluster
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: managedstate
        in: query
        description: Whether this cluster is managed by cloudstack
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Lists clusters by the cluster name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: Lists clusters by Pod ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: showcapacities
        in: query
        description: Flag to display the capacity of the clusters
        schema:
          type: boolean
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: zoneid
        in: query
        description: Lists clusters by Zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listClusters`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listclustersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      cluster:
                        type: array
                        items:
                          $ref: '#/components/schemas/Cluster'
                    additionalProperties: true
                required:
                - listclustersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listclustersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listclustersresponse
      x-cloudstack-command: listClusters
      x-cloudstack-async: false
      x-cloudstack-related:
      - addCluster
      - updateCluster
  /listClustersMetrics:
    get:
      operationId: listClustersMetrics
      summary: Lists clusters metrics
      tags:
      - ClustersMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listClustersMetrics
          default: listClustersMetrics
      - $ref: '#/components/parameters/response'
      - name: allocationstate
        in: query
        description: Lists clusters by allocation state
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: CPU arch of the clusters
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: clustertype
        in: query
        description: Lists clusters by cluster type
        schema:
          type: string
          maxLength: 255
      - name: hypervisor
        in: query
        description: Lists clusters by hypervisor type
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: Lists clusters by the cluster ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: managedstate
        in: query
        description: Whether this cluster is managed by cloudstack
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Lists clusters by the cluster name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: Lists clusters by Pod ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: showcapacities
        in: query
        description: Flag to display the capacity of the clusters
        schema:
          type: boolean
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: zoneid
        in: query
        description: Lists clusters by Zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listClustersMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listclustersmetricsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      cluster:
                        type: array
                        items:
                          $ref: '#/components/schemas/ClustersMetric'
                    additionalProperties: true
                required:
                - listclustersmetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listclustersmetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listclustersmetricsresponse
      x-cloudstack-command: listClustersMetrics
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.3
  /listCniConfiguration:
    get:
      operationId: listCniConfiguration
      summary: List user data for CNI plugins
      tags:
      - CniConfiguration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCniConfiguration
          default: listCniConfiguration
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: The ID of the Userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listCniConfiguration
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Userdata name to look for
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listCniConfiguration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcniconfigurationresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id209
                        $ref: '#/components/schemas/ListCniConfigurationResult'
                      - type: array
                        items: *id209
                required:
                - listcniconfigurationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcniconfigurationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listcniconfigurationresponse
      x-cloudstack-command: listCniConfiguration
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /listConditions:
    get:
      operationId: listConditions
      summary: List Conditions for Instance auto scaling
      tags:
      - Condition
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listConditions
          default: listConditions
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: counterid
        in: query
        description: Counter-id of the condition.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createCounter
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: ID of the Condition.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listConditions
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: policyid
        in: query
        description: The ID of the policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listAutoScalePolicies
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `listConditions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listconditionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id210
                        $ref: '#/components/schemas/Condition'
                      - type: array
                        items: *id210
                required:
                - listconditionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listconditionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listconditionsresponse
      x-cloudstack-command: listConditions
      x-cloudstack-async: false
  /listConfigurationGroups:
    get:
      operationId: listConfigurationGroups
      summary: Lists all configuration groups (primarily used for UI).
      tags:
      - ConfigurationGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listConfigurationGroups
          default: listConfigurationGroups
      - $ref: '#/components/parameters/response'
      - name: group
        in: query
        description: Lists configuration group by group name
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listConfigurationGroups`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listconfigurationgroupsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      configurationgroup:
                        type: array
                        items:
                          $ref: '#/components/schemas/ConfigurationGroup'
                    additionalProperties: true
                required:
                - listconfigurationgroupsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listconfigurationgroupsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listconfigurationgroupsresponse
      x-cloudstack-command: listConfigurationGroups
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
  /listConfigurations:
    get:
      operationId: listConfigurations
      summary: Lists all configurations.
      tags:
      - Configuration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listConfigurations
          default: listConfigurations
      - $ref: '#/components/parameters/response'
      - name: accountid
        in: query
        description: The ID of the Account to update the parameter value for corresponding account
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - markDefaultZoneForAccount
        - updateAccount
      - name: category
        in: query
        description: Lists configurations by category
        schema:
          type: string
          maxLength: 255
      - name: clusterid
        in: query
        description: The ID of the Cluster to update the parameter value for corresponding cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: domainid
        in: query
        description: The ID of the Domain to update the parameter value for corresponding domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: group
        in: query
        description: Lists configuration by group name (primarily used for UI)
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: imagestoreuuid
        in: query
        description: The ID of the Image Store to update the parameter value for corresponding image store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - listSwifts
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: managementserverid
        in: query
        description: the ID of the Management Server to update the parameter value for corresponding management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - listManagementServers
      - name: name
        in: query
        description: Lists configuration by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: parent
        in: query
        description: Lists configuration by parent name (primarily used for UI)
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: storageid
        in: query
        description: The ID of the Storage pool to update the parameter value for corresponding storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
      - name: subgroup
        in: query
        description: Lists configuration by subgroup name (primarily used for UI)
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: zoneid
        in: query
        description: The ID of the Zone to update the parameter value for corresponding zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listConfigurations`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listconfigurationsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      configuration:
                        type: array
                        items:
                          $ref: '#/components/schemas/Configuration'
                    additionalProperties: true
                required:
                - listconfigurationsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listconfigurationsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listconfigurationsresponse
      x-cloudstack-command: listConfigurations
      x-cloudstack-async: false
  /listConsoleSessions:
    get:
      operationId: listConsoleSessions
      summary: Lists console sessions.
      tags:
      - ConsoleSession
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listConsoleSessions
          default: listConsoleSessions
      - $ref: '#/components/parameters/response'
      - name: accountid
        in: query
        description: The ID of the account that created the console endpoint.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - updateAccount
      - name: acquired
        in: query
        description: Lists acquired console sessions, defaults to false. Acquired console sessions are the ones that have been accessed. The 'activeonly' parameter has precedence over the 'acquired' parameter, i.e., when the 'activeonly' parameter is 'true', the 'acquired' parameter value will be ignored.
        schema:
          type: boolean
      - name: activeonly
        in: query
        description: Lists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.
        schema:
          type: boolean
      - name: clientaddress
        in: query
        description: IP address of the client that accessed the console session.
        schema:
          type: string
          maxLength: 255
      - name: consoleendpointcreatoraddress
        in: query
        description: IP address of the creator of the console endpoint.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID of the account that created the console endpoint.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: enddate
        in: query
        description: 'Lists console sessions generated up until this date. The recommended format is "yyyy-MM-dd''T''HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".'
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: hostid
        in: query
        description: Lists console sessions from the specified host.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: id
        in: query
        description: The ID of the console session.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listConsoleSessions
      - name: isrecursive
        in: query
        description: Lists console sessions recursively per domain. If an account ID is informed, only the account's console sessions will be listed. Defaults to false.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: startdate
        in: query
        description: 'Lists console sessions generated from this date onwards. The recommended format is "yyyy-MM-dd''T''HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".'
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: userid
        in: query
        description: The ID of the user that created the console endpoint.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
        - lockUser
      - name: virtualmachineid
        in: query
        description: The ID of the virtual machine.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `listConsoleSessions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listconsolesessionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      consolesession:
                        type: array
                        items:
                          $ref: '#/components/schemas/ConsoleSession'
                    additionalProperties: true
                required:
                - listconsolesessionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listconsolesessionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listconsolesessionsresponse
      x-cloudstack-command: listConsoleSessions
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /listCounters:
    get:
      operationId: listCounters
      summary: List the counters for Instance auto scaling
      tags:
      - Counter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCounters
          default: listCounters
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the Counter.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createCounter
        - listCounters
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the counter.
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: provider
        in: query
        description: Network provider of the counter.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: source
        in: query
        description: Source of the counter.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listCounters`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcountersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      counter:
                        type: array
                        items:
                          $ref: '#/components/schemas/Counter'
                    additionalProperties: true
                required:
                - listcountersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcountersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listcountersresponse
      x-cloudstack-command: listCounters
      x-cloudstack-async: false
      x-cloudstack-related:
      - createCounter
  /listCustomActions:
    get:
      operationId: listCustomActions
      summary: Lists the custom actions
      tags:
      - CustomAction
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listCustomActions
          default: listCustomActions
      - $ref: '#/components/parameters/response'
      - name: enabled
        in: query
        description: List actions whether they are enabled or not
        schema:
          type: boolean
      - name: extensionid
        in: query
        description: uuid of the extension
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listExtensions
        - updateExtension
      - name: id
        in: query
        description: uuid of the custom action
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listCustomActions
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the custom action
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: resourceid
        in: query
        description: ID of a resource for actions
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of the resource for actions
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listCustomActions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcustomactionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      extensioncustomaction:
                        type: array
                        items:
                          $ref: '#/components/schemas/CustomAction'
                    additionalProperties: true
                required:
                - listcustomactionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listcustomactionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listcustomactionsresponse
      x-cloudstack-command: listCustomActions
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /listDbMetrics:
    get:
      operationId: listDbMetrics
      summary: List the db hosts and statistics
      tags:
      - DbMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDbMetrics
          default: listDbMetrics
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `listDbMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdbmetricsresponse:
                    type: object
                    properties:
                      dbMetrics:
                        $ref: '#/components/schemas/DbMetric'
                    additionalProperties: true
                required:
                - listdbmetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdbmetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdbmetricsresponse
      x-cloudstack-command: listDbMetrics
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /listDedicatedClusters:
    get:
      operationId: listDedicatedClusters
      summary: Lists dedicated clusters.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDedicatedClusters
          default: listDedicatedClusters
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The name of the account associated with the cluster. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: affinitygroupid
        in: query
        description: List dedicated clusters by affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: clusterid
        in: query
        description: The ID of the cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: domainid
        in: query
        description: The ID of the domain associated with the cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listDedicatedClusters`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedclustersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id211
                        $ref: '#/components/schemas/DedicateClusterResult'
                      - type: array
                        items: *id211
                required:
                - listdedicatedclustersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedclustersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdedicatedclustersresponse
      x-cloudstack-command: listDedicatedClusters
      x-cloudstack-async: false
  /listDedicatedGuestVlanRanges:
    get:
      operationId: listDedicatedGuestVlanRanges
      summary: Lists dedicated guest vlan ranges
      tags:
      - DedicatedGuestVlanRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDedicatedGuestVlanRanges
          default: listDedicatedGuestVlanRanges
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The account with which the guest VLAN range is associated. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID with which the guest VLAN range is associated.  If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: guestvlanrange
        in: query
        description: The dedicated guest vlan range
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: List dedicated guest VLAN ranges by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - dedicateGuestVlanRange
        - listDedicatedGuestVlanRanges
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: Physical network ID of the guest VLAN range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: projectid
        in: query
        description: Project who will own the guest VLAN range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: zoneid
        in: query
        description: Zone of the guest VLAN range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listDedicatedGuestVlanRanges`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedguestvlanrangesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id212
                        $ref: '#/components/schemas/DedicateGuestVlanRangeResult'
                      - type: array
                        items: *id212
                required:
                - listdedicatedguestvlanrangesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedguestvlanrangesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdedicatedguestvlanrangesresponse
      x-cloudstack-command: listDedicatedGuestVlanRanges
      x-cloudstack-async: false
      x-cloudstack-related:
      - dedicateGuestVlanRange
  /listDedicatedHosts:
    get:
      operationId: listDedicatedHosts
      summary: Lists dedicated hosts.
      tags:
      - DedicatedHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDedicatedHosts
          default: listDedicatedHosts
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The name of the account associated with the host. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: affinitygroupid
        in: query
        description: List dedicated hosts by affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the domain associated with the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: hostid
        in: query
        description: The ID of the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listDedicatedHosts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedhostsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id213
                        $ref: '#/components/schemas/DedicateHostResult'
                      - type: array
                        items: *id213
                required:
                - listdedicatedhostsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedhostsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdedicatedhostsresponse
      x-cloudstack-command: listDedicatedHosts
      x-cloudstack-async: false
  /listDedicatedPods:
    get:
      operationId: listDedicatedPods
      summary: Lists dedicated pods.
      tags:
      - DedicatedPod
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDedicatedPods
          default: listDedicatedPods
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The name of the account associated with the pod. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: affinitygroupid
        in: query
        description: List dedicated pods by affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the domain associated with the pod
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The ID of the pod
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      responses:
        '200':
          description: Successful invocation of `listDedicatedPods`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedpodsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id214
                        $ref: '#/components/schemas/DedicatePodResult'
                      - type: array
                        items: *id214
                required:
                - listdedicatedpodsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedpodsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdedicatedpodsresponse
      x-cloudstack-command: listDedicatedPods
      x-cloudstack-async: false
  /listDedicatedZones:
    get:
      operationId: listDedicatedZones
      summary: List dedicated zones.
      tags:
      - DedicatedZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDedicatedZones
          default: listDedicatedZones
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The name of the account associated with the zone. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: affinitygroupid
        in: query
        description: List dedicated zones by affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAffinityGroup
        - listAffinityGroups
      - name: domainid
        in: query
        description: The ID of the domain associated with the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of the Zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listDedicatedZones`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedzonesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id215
                        $ref: '#/components/schemas/DedicateZoneResult'
                      - type: array
                        items: *id215
                required:
                - listdedicatedzonesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdedicatedzonesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdedicatedzonesresponse
      x-cloudstack-command: listDedicatedZones
      x-cloudstack-async: false
      x-cloudstack-related:
      - dedicateZone
  /listDeploymentPlanners:
    get:
      operationId: listDeploymentPlanners
      summary: Lists all DeploymentPlanners available.
      tags:
      - DeploymentPlanner
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDeploymentPlanners
          default: listDeploymentPlanners
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listDeploymentPlanners`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdeploymentplannersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      deploymentPlanner:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListDeploymentPlannersResult'
                    additionalProperties: true
                required:
                - listdeploymentplannersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdeploymentplannersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdeploymentplannersresponse
      x-cloudstack-command: listDeploymentPlanners
      x-cloudstack-async: false
  /listDetailOptions:
    get:
      operationId: listDetailOptions
      summary: Lists all possible details and their options for a resource type such as an Instance or a Template
      tags:
      - DetailOption
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDetailOptions
          default: listDetailOptions
      - $ref: '#/components/parameters/response'
      - name: resourcetype
        in: query
        description: The resource type such as UserVm, Template etc.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourceid
        in: query
        description: The UUID of the resource (optional)
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listDetailOptions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdetailoptionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id216
                        $ref: '#/components/schemas/DetailOption'
                      - type: array
                        items: *id216
                required:
                - listdetailoptionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdetailoptionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdetailoptionsresponse
      x-cloudstack-command: listDetailOptions
      x-cloudstack-async: false
      x-cloudstack-since: '4.13'
  /listDiskOfferings:
    get:
      operationId: listDiskOfferings
      summary: Lists all available disk offerings.
      tags:
      - DiskOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDiskOfferings
          default: listDiskOfferings
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: encrypt
        in: query
        description: Listed offerings support disk encryption
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: id
        in: query
        description: ID of the disk offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
        - listDiskOfferings
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Name of the disk offering
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: state
        in: query
        description: Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.19'
      - name: storageid
        in: query
        description: The ID of the storage pool, tags of the storage pool are used to filter the offerings
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: storagetype
        in: query
        description: the storage type of the service offering. Values are local and shared.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.19'
      - name: virtualmachineid
        in: query
        description: The ID of a virtual machine. Pass this in if you want to see the suitable disk offering that can be used to create and add a disk to the virtual machine. Suitability is returned with suitableforvirtualmachine flag in the response
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.20.0
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: volumeid
        in: query
        description: The ID of the volume, tags of the volume are used to filter the offerings
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: zoneid
        in: query
        description: ID of zone disk offering is associated with
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listDiskOfferings`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdiskofferingsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      diskoffering:
                        type: array
                        items:
                          $ref: '#/components/schemas/DiskOffering'
                    additionalProperties: true
                required:
                - listdiskofferingsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdiskofferingsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdiskofferingsresponse
      x-cloudstack-command: listDiskOfferings
      x-cloudstack-async: false
      x-cloudstack-related:
      - cloneDiskOffering
      - createDiskOffering
  /listDnsProviders:
    get:
      operationId: listDnsProviders
      summary: Lists available DNS plugin providers
      tags:
      - DnsProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDnsProviders
          default: listDnsProviders
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listDnsProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdnsprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      dnsprovider:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListDeploymentPlannersResult'
                    additionalProperties: true
                required:
                - listdnsprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdnsprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdnsprovidersresponse
      x-cloudstack-command: listDnsProviders
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /listDnsRecords:
    get:
      operationId: listDnsRecords
      summary: Lists DNS records from the external provider
      tags:
      - DnsRecord
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDnsRecords
          default: listDnsRecords
      - $ref: '#/components/parameters/response'
      - name: dnszoneid
        in: query
        description: ID of the DNS zone to list records from
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDnsZone
        - listDnsZones
        - updateDnsZone
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listDnsRecords`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdnsrecordsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id217
                        $ref: '#/components/schemas/DnsRecord'
                      - type: array
                        items: *id217
                required:
                - listdnsrecordsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdnsrecordsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdnsrecordsresponse
      x-cloudstack-command: listDnsRecords
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createDnsRecord
  /listDnsServers:
    get:
      operationId: listDnsServers
      summary: Lists DNS servers owned by the account.
      tags:
      - DnsServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDnsServers
          default: listDnsServers
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: the ID of the DNS server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addDnsServer
        - listDnsServers
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: providertype
        in: query
        description: filter by provider type (e.g. PowerDNS, Cloudflare)
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listDnsServers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdnsserversresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id218
                        $ref: '#/components/schemas/DnsServer'
                      - type: array
                        items: *id218
                required:
                - listdnsserversresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdnsserversresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdnsserversresponse
      x-cloudstack-command: listDnsServers
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - addDnsServer
  /listDnsZones:
    get:
      operationId: listDnsZones
      summary: Lists DNS zones.
      tags:
      - DnsZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDnsZones
          default: listDnsZones
      - $ref: '#/components/parameters/response'
      - name: dnsserverid
        in: query
        description: List DNS zones belonging to a specific DNS server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addDnsServer
      - name: id
        in: query
        description: List DNS zone by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDnsZones
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List by zone name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listDnsZones`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdnszonesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id219
                        $ref: '#/components/schemas/DnsZone'
                      - type: array
                        items: *id219
                required:
                - listdnszonesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdnszonesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdnszonesresponse
      x-cloudstack-command: listDnsZones
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /listDomainChildren:
    get:
      operationId: listDomainChildren
      summary: Lists all children domains belonging to a specified domain
      tags:
      - DomainChildren
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDomainChildren
          default: listDomainChildren
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: List children domain by parent domain ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: isrecursive
        in: query
        description: To return the entire tree, use the value "true". To return the first level children, use the value "false".
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false
        schema:
          type: boolean
      - name: name
        in: query
        description: List children domains by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showicon
        in: query
        description: Flag to display the resource icon for domains
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `listDomainChildren`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdomainchildrenresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id220
                        $ref: '#/components/schemas/Domain'
                      - type: array
                        items: *id220
                required:
                - listdomainchildrenresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdomainchildrenresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdomainchildrenresponse
      x-cloudstack-command: listDomainChildren
      x-cloudstack-async: false
      x-cloudstack-related:
      - createDomain
      - listDomains
      - moveDomain
  /listDomains:
    get:
      operationId: listDomains
      summary: Lists domains and provides detailed information for listed domains
      tags:
      - Domain
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listDomains
          default: listDomains
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: Comma separated list of domain details requested, value can be a list of [ all, resource, min]. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: List domain by domain ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: level
        in: query
        description: List domains by domain level.
        schema:
          type: integer
          format: int32
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false
        schema:
          type: boolean
      - name: name
        in: query
        description: List domain by domain name.
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: showicon
        in: query
        description: Flag to display the resource icon for domains
        schema:
          type: boolean
      - name: tag
        in: query
        description: Tag for resource type to return usage
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `listDomains`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdomainsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      domain:
                        type: array
                        items:
                          $ref: '#/components/schemas/Domain'
                    additionalProperties: true
                required:
                - listdomainsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listdomainsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listdomainsresponse
      x-cloudstack-command: listDomains
      x-cloudstack-async: false
      x-cloudstack-related:
      - listDomains
  /listEgressFirewallRules:
    get:
      operationId: listEgressFirewallRules
      summary: Lists all egress firewall rules for network ID.
      tags:
      - EgressFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listEgressFirewallRules
          default: listEgressFirewallRules
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: Lists rule with the specified ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listIpv6FirewallRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
        - updateRoutingFirewallRule
      - name: ipaddressid
        in: query
        description: The ID of IP address of the firewall services
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: networkid
        in: query
        description: The network ID for the egress firewall services
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `listEgressFirewallRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listegressfirewallrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id221
                        $ref: '#/components/schemas/EgressFirewallRule'
                      - type: array
                        items: *id221
                required:
                - listegressfirewallrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listegressfirewallrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listegressfirewallrulesresponse
      x-cloudstack-command: listEgressFirewallRules
      x-cloudstack-async: false
      x-cloudstack-related:
      - createFirewallRule
      - listFirewallRules
      - updateEgressFirewallRule
      - updateFirewallRule
  /listElastistorInterface:
    get:
      operationId: listElastistorInterface
      summary: Lists the network Interfaces of elastistor
      tags:
      - ElastistorInterface
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listElastistorInterface
          default: listElastistorInterface
      - $ref: '#/components/parameters/response'
      - name: controllerid
        in: query
        description: Controller ID
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listElastistorInterface`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listelastistorinterfaceresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id222
                        $ref: '#/components/schemas/ListElastistorInterfaceResult'
                      - type: array
                        items: *id222
                required:
                - listelastistorinterfaceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listelastistorinterfaceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listelastistorinterfaceresponse
      x-cloudstack-command: listElastistorInterface
      x-cloudstack-async: false
      x-cloudstack-related:
      - listElastistorVolume
  /listElastistorPool:
    get:
      operationId: listElastistorPool
      summary: Lists the pools of elastistor
      tags:
      - ElastistorPool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listElastistorPool
          default: listElastistorPool
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Pool
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `listElastistorPool`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listelastistorpoolresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id223
                        $ref: '#/components/schemas/ElastistorPool'
                      - type: array
                        items: *id223
                required:
                - listelastistorpoolresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listelastistorpoolresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listelastistorpoolresponse
      x-cloudstack-command: listElastistorPool
      x-cloudstack-async: false
  /listElastistorVolume:
    get:
      operationId: listElastistorVolume
      summary: Lists the volumes of elastistor
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listElastistorVolume
          default: listElastistorVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the account
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listElastistorVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listelastistorvolumeresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id224
                        $ref: '#/components/schemas/ListElastistorInterfaceResult'
                      - type: array
                        items: *id224
                required:
                - listelastistorvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listelastistorvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listelastistorvolumeresponse
      x-cloudstack-command: listElastistorVolume
      x-cloudstack-async: false
  /listEventTypes:
    get:
      operationId: listEventTypes
      summary: List Event Types
      tags:
      - EventType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listEventTypes
          default: listEventTypes
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `listEventTypes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listeventtypesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      eventtype:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListDeploymentPlannersResult'
                    additionalProperties: true
                required:
                - listeventtypesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listeventtypesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listeventtypesresponse
      x-cloudstack-command: listEventTypes
      x-cloudstack-async: false
  /listEvents:
    get:
      operationId: listEvents
      summary: A command to list events.
      tags:
      - Event
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listEvents
          default: listEvents
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: archived
        in: query
        description: True to list archived events otherwise false
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: duration
        in: query
        description: The duration of the event
        schema:
          type: integer
          format: int32
      - name: enddate
        in: query
        description: The end date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: entrytime
        in: query
        description: The time the event was entered
        schema:
          type: integer
          format: int32
      - name: id
        in: query
        description: The ID of the event
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listEvents
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: level
        in: query
        description: The event level (INFO, WARN, ERROR)
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      - name: resourceid
        in: query
        description: The ID of the resource associated with the event
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.17.0
      - name: resourcetype
        in: query
        description: The type of the resource associated with the event
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.17.0
      - name: startdate
        in: query
        description: The start date range of the list you want to retrieve (use format "yyyy-MM-dd" or the new format "yyyy-MM-dd HH:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: startid
        in: query
        description: The parent/start ID of the event, when provided this will list all the events with the start/parent ID including the parent event
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listEvents
      - name: state
        in: query
        description: The state of the events
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: type
        in: query
        description: The event type (see event types)
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listEvents`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listeventsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      event:
                        type: array
                        items:
                          $ref: '#/components/schemas/Event'
                    additionalProperties: true
                required:
                - listeventsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listeventsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listeventsresponse
      x-cloudstack-command: listEvents
      x-cloudstack-async: false
  /listExtensions:
    get:
      operationId: listExtensions
      summary: Lists extensions
      tags:
      - Extension
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listExtensions
          default: listExtensions
      - $ref: '#/components/parameters/response'
      - name: details
        in: query
        description: comma separated list of extension details requested, value can be a list of [all, resources, external, min]. When no parameters are passed, all the details are returned. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: id
        in: query
        description: uuid of the extension
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listExtensions
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the extension
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: type
        in: query
        description: Type of the extension (e.g. Orchestrator, NetworkOrchestrator)
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      responses:
        '200':
          description: Successful invocation of `listExtensions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listextensionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      extension:
                        type: array
                        items:
                          $ref: '#/components/schemas/Extension'
                    additionalProperties: true
                required:
                - listextensionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listextensionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listextensionsresponse
      x-cloudstack-command: listExtensions
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /listFirewallRules:
    get:
      operationId: listFirewallRules
      summary: Lists all firewall rules for an IP address.
      tags:
      - FirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listFirewallRules
          default: listFirewallRules
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: Lists rule with the specified ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updatePortForwardingRule
      - name: ipaddressid
        in: query
        description: The ID of IP address of the firewall services
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - updateIpAddress
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: networkid
        in: query
        description: List firewall rules for certain network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.3'
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `listFirewallRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listfirewallrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      firewallrule:
                        type: array
                        items:
                          $ref: '#/components/schemas/EgressFirewallRule'
                    additionalProperties: true
                required:
                - listfirewallrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listfirewallrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listfirewallrulesresponse
      x-cloudstack-command: listFirewallRules
      x-cloudstack-async: false
      x-cloudstack-related:
      - createFirewallRule
      - updateEgressFirewallRule
  /listGlobalLoadBalancerRules:
    get:
      operationId: listGlobalLoadBalancerRules
      summary: Lists load balancer rules.
      tags:
      - GlobalLoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listGlobalLoadBalancerRules
          default: listGlobalLoadBalancerRules
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: The ID of the global load balancer rule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGlobalLoadBalancerRules
        - updateGlobalLoadBalancerRule
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: regionid
        in: query
        description: Region ID
        schema:
          type: integer
          format: int32
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `listGlobalLoadBalancerRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listgloballoadbalancerrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id225
                        $ref: '#/components/schemas/GlobalLoadBalancerRule'
                      - type: array
                        items: *id225
                required:
                - listgloballoadbalancerrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listgloballoadbalancerrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listgloballoadbalancerrulesresponse
      x-cloudstack-command: listGlobalLoadBalancerRules
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateGlobalLoadBalancerRule
  /listGpuCards:
    get:
      operationId: listGpuCards
      summary: Lists all available GPU cards
      tags:
      - GpuCard
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listGpuCards
          default: listGpuCards
      - $ref: '#/components/parameters/response'
      - name: activeonly
        in: query
        description: If true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.
        schema:
          type: boolean
      - name: deviceid
        in: query
        description: device ID of the GPU card
        schema:
          type: string
          maxLength: 255
      - name: devicename
        in: query
        description: device name of the GPU card
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: ID of the GPU card
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGpuCards
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: vendorid
        in: query
        description: vendor ID of the GPU card
        schema:
          type: string
          maxLength: 255
      - name: vendorname
        in: query
        description: vendor name of the GPU card
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listGpuCards`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listgpucardsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id226
                        $ref: '#/components/schemas/GpuCard'
                      - type: array
                        items: *id226
                required:
                - listgpucardsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listgpucardsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listgpucardsresponse
      x-cloudstack-command: listGpuCards
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /listGpuDevices:
    get:
      operationId: listGpuDevices
      summary: Lists all available GPU devices
      tags:
      - GpuDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listGpuDevices
          default: listGpuDevices
      - $ref: '#/components/parameters/response'
      - name: gpucardid
        in: query
        description: the GPU card ID associated with the GPU device
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGpuCards
      - name: hostid
        in: query
        description: the host ID where the GPU device is attached
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: id
        in: query
        description: ID of the GPU device
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createGpuDevice
        - discoverGpuDevices
        - listGpuDevices
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: vgpuprofileid
        in: query
        description: the vGPU profile ID assigned to the GPU device
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVgpuProfile
        - updateVgpuProfile
      - name: virtualmachineid
        in: query
        description: the virtual machine ID to which the GPU device is allocated
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `listGpuDevices`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listgpudevicesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id227
                        $ref: '#/components/schemas/GpuDevice'
                      - type: array
                        items: *id227
                required:
                - listgpudevicesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listgpudevicesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listgpudevicesresponse
      x-cloudstack-command: listGpuDevices
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - createGpuDevice
      - discoverGpuDevices
      - listGpuDevices
  /listGuestNetworkIpv6Prefixes:
    get:
      operationId: listGuestNetworkIpv6Prefixes
      summary: Lists guest network IPv6 prefixes
      tags:
      - GuestNetworkIpv6Prefixe
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listGuestNetworkIpv6Prefixes
          default: listGuestNetworkIpv6Prefixes
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: UUID of the IPv6 prefix.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGuestNetworkIpv6Prefixes
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: UUID of zone to which the IPv6 prefix belongs to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listGuestNetworkIpv6Prefixes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listguestnetworkipv6prefixesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id228
                        $ref: '#/components/schemas/CreateGuestNetworkIpv6PrefixResult'
                      - type: array
                        items: *id228
                required:
                - listguestnetworkipv6prefixesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listguestnetworkipv6prefixesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listguestnetworkipv6prefixesresponse
      x-cloudstack-command: listGuestNetworkIpv6Prefixes
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /listGuestOsMapping:
    get:
      operationId: listGuestOsMapping
      summary: Lists all available OS mappings for given hypervisor
      tags:
      - GuestOsMapping
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listGuestOsMapping
          default: listGuestOsMapping
      - $ref: '#/components/parameters/response'
      - name: hypervisor
        in: query
        description: List Guest OS mapping by hypervisor
        schema:
          type: string
          maxLength: 255
      - name: hypervisorversion
        in: query
        description: List Guest OS mapping by hypervisor version. Must be used with hypervisor parameter
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: List mapping by its UUID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOsMapping
        - listGuestOsMapping
        - updateGuestOsMapping
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: osdisplayname
        in: query
        description: List Guest OS mapping by OS display name
        schema:
          type: string
          maxLength: 255
      - name: osnameforhypervisor
        in: query
        description: List Guest OS mapping by OS mapping name with hypervisor
        schema:
          type: string
          maxLength: 255
      - name: ostypeid
        in: query
        description: List mapping by Guest OS Type UUID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listGuestOsMapping`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listguestosmappingresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      guestosmapping:
                        type: array
                        items:
                          $ref: '#/components/schemas/GuestOsMapping'
                    additionalProperties: true
                required:
                - listguestosmappingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listguestosmappingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listguestosmappingresponse
      x-cloudstack-command: listGuestOsMapping
      x-cloudstack-async: false
      x-cloudstack-since: 4.4.0
      x-cloudstack-related:
      - addGuestOsMapping
      - updateGuestOsMapping
  /listGuestVlans:
    get:
      operationId: listGuestVlans
      summary: Lists all guest vlans
      tags:
      - GuestVlan
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listGuestVlans
          default: listGuestVlans
      - $ref: '#/components/parameters/response'
      - name: allocatedonly
        in: query
        description: Limits search results to allocated guest VLAN. False by default.
        schema:
          type: boolean
      - name: id
        in: query
        description: List guest VLAN by ID
        schema:
          type: integer
          format: int64
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: List guest VLAN by physical network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: vnet
        in: query
        description: List guest VLAN by vnet
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: List guest VLAN by zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listGuestVlans`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listguestvlansresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      guestvlan:
                        type: array
                        items:
                          $ref: '#/components/schemas/GuestVlan'
                    additionalProperties: true
                required:
                - listguestvlansresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listguestvlansresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listguestvlansresponse
      x-cloudstack-command: listGuestVlans
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /listGuiThemes:
    get:
      operationId: listGuiThemes
      summary: Lists GUI themes.
      tags:
      - GuiTheme
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listGuiThemes
          default: listGuiThemes
      - $ref: '#/components/parameters/response'
      - name: accountid
        in: query
        description: The ID of the account to be filtered.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      - name: commonname
        in: query
        description: The internet Common Name (CN) to be filtered.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the domain to be filtered.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: The theme ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createGuiTheme
        - listGuiThemes
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: Whether to list all themes.
        schema:
          type: boolean
      - name: listonlydefaulttheme
        in: query
        description: Whether to only list the default theme.
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the theme.
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showpublic
        in: query
        description: Whether to list public themes.
        schema:
          type: boolean
      - name: showremoved
        in: query
        description: Whether to list removed themes.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `listGuiThemes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listguithemesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id229
                        $ref: '#/components/schemas/GuiTheme'
                      - type: array
                        items: *id229
                required:
                - listguithemesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listguithemesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listguithemesresponse
      x-cloudstack-command: listGuiThemes
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0.0
      x-cloudstack-related:
      - createGuiTheme
  /listHSMProfiles:
    get:
      operationId: listHSMProfiles
      summary: Lists HSM profiles
      tags:
      - HSMProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listHSMProfiles
          default: listHSMProfiles
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: enabled
        in: query
        description: list only enabled profiles
        schema:
          type: boolean
      - name: id
        in: query
        description: the HSM profile ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listHSMProfiles
      - name: ispublic
        in: query
        description: when true, non-admin users see only system (global) profiles
        schema:
          type: boolean
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: protocol
        in: query
        description: the protocol of the HSM profile
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: the zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listHSMProfiles`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhsmprofilesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id230
                        $ref: '#/components/schemas/HSMProfile'
                      - type: array
                        items: *id230
                required:
                - listhsmprofilesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhsmprofilesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listhsmprofilesresponse
      x-cloudstack-command: listHSMProfiles
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /listHostHAProviders:
    get:
      operationId: listHostHAProviders
      summary: Lists HA providers
      tags:
      - HostHAProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listHostHAProviders
          default: listHostHAProviders
      - $ref: '#/components/parameters/response'
      - name: hypervisor
        in: query
        description: Hypervisor type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listHostHAProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhosthaprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id231
                        $ref: '#/components/schemas/HAForHost'
                      - type: array
                        items: *id231
                required:
                - listhosthaprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhosthaprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listhosthaprovidersresponse
      x-cloudstack-command: listHostHAProviders
      x-cloudstack-async: false
      x-cloudstack-since: '4.11'
      x-cloudstack-related:
      - configureHAForHost
      - disableHAForHost
      - enableHAForHost
  /listHostHAResources:
    get:
      operationId: listHostHAResources
      summary: Lists host HA resources
      tags:
      - HostHAResource
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listHostHAResources
          default: listHostHAResources
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: List by host ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - cancelHostAsDegraded
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `listHostHAResources`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhostharesourcesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id232
                        $ref: '#/components/schemas/HAForHost'
                      - type: array
                        items: *id232
                required:
                - listhostharesourcesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhostharesourcesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listhostharesourcesresponse
      x-cloudstack-command: listHostHAResources
      x-cloudstack-async: false
      x-cloudstack-since: '4.11'
      x-cloudstack-related:
      - configureHAForHost
      - disableHAForHost
      - enableHAForHost
      - listHostHAProviders
  /listHostTags:
    get:
      operationId: listHostTags
      summary: Lists host tags
      tags:
      - HostTag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listHostTags
          default: listHostTags
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listHostTags`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhosttagsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      hosttag:
                        type: array
                        items:
                          $ref: '#/components/schemas/HostTag'
                    additionalProperties: true
                required:
                - listhosttagsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhosttagsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listhosttagsresponse
      x-cloudstack-command: listHostTags
      x-cloudstack-async: false
  /listHosts:
    get:
      operationId: listHosts
      summary: Lists hosts.
      tags:
      - Host
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listHosts
          default: listHosts
      - $ref: '#/components/parameters/response'
      - name: arch
        in: query
        description: CPU Arch of the host
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: clusterid
        in: query
        description: Lists hosts existing in particular cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: details
        in: query
        description: Comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: hahost
        in: query
        description: If true, list only hosts dedicated to HA
        schema:
          type: boolean
      - name: hypervisor
        in: query
        description: 'Hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator'
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: managementserverid
        in: query
        description: the id of the management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listManagementServers
      - name: name
        in: query
        description: The name of the host
        schema:
          type: string
          maxLength: 255
      - name: outofbandmanagementenabled
        in: query
        description: List hosts for which out-of-band management is enabled
        schema:
          type: boolean
      - name: outofbandmanagementpowerstate
        in: query
        description: List hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The Pod ID for the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - listPods
      - name: resourcestate
        in: query
        description: List hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]
        schema:
          type: string
          maxLength: 255
      - name: state
        in: query
        description: The state of the host
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: type
        in: query
        description: The host type
        schema:
          type: string
          maxLength: 255
      - name: version
        in: query
        description: the host version
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.3
      - name: virtualmachineid
        in: query
        description: Lists hosts in the same cluster as this Instance and flag hosts with enough CPU/RAm to host this Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: zoneid
        in: query
        description: The Zone ID for the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listHosts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhostsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      host:
                        type: array
                        items:
                          $ref: '#/components/schemas/Host'
                    additionalProperties: true
                required:
                - listhostsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhostsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listhostsresponse
      x-cloudstack-command: listHosts
      x-cloudstack-async: false
      x-cloudstack-related:
      - declareHostAsDegraded
      - reconnectHost
  /listHostsMetrics:
    get:
      operationId: listHostsMetrics
      summary: Lists hosts metrics
      tags:
      - HostsMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listHostsMetrics
          default: listHostsMetrics
      - $ref: '#/components/parameters/response'
      - name: arch
        in: query
        description: CPU Arch of the host
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: clusterid
        in: query
        description: Lists hosts existing in particular cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: details
        in: query
        description: Comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: hahost
        in: query
        description: If true, list only hosts dedicated to HA
        schema:
          type: boolean
      - name: hypervisor
        in: query
        description: 'Hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator'
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: managementserverid
        in: query
        description: the id of the management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listManagementServers
      - name: name
        in: query
        description: The name of the host
        schema:
          type: string
          maxLength: 255
      - name: outofbandmanagementenabled
        in: query
        description: List hosts for which out-of-band management is enabled
        schema:
          type: boolean
      - name: outofbandmanagementpowerstate
        in: query
        description: List hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The Pod ID for the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - listPods
      - name: resourcestate
        in: query
        description: List hosts by resource state. Resource state represents current state determined by admin of host, value can be one of [Enabled, Disabled, Unmanaged, PrepareForMaintenance, ErrorInMaintenance, Maintenance, Error]
        schema:
          type: string
          maxLength: 255
      - name: state
        in: query
        description: The state of the host
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: type
        in: query
        description: The host type
        schema:
          type: string
          maxLength: 255
      - name: version
        in: query
        description: the host version
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.3
      - name: virtualmachineid
        in: query
        description: Lists hosts in the same cluster as this Instance and flag hosts with enough CPU/RAm to host this Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: zoneid
        in: query
        description: The Zone ID for the host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listHostsMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhostsmetricsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      host:
                        type: array
                        items:
                          $ref: '#/components/schemas/HostsMetric'
                    additionalProperties: true
                required:
                - listhostsmetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhostsmetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listhostsmetricsresponse
      x-cloudstack-command: listHostsMetrics
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.3
  /listHypervisorCapabilities:
    get:
      operationId: listHypervisorCapabilities
      summary: Lists all hypervisor capabilities.
      tags:
      - HypervisorCapability
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listHypervisorCapabilities
          default: listHypervisorCapabilities
      - $ref: '#/components/parameters/response'
      - name: hypervisor
        in: query
        description: The hypervisor for which to restrict the search
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: ID of the hypervisor capability
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listHypervisorCapabilities
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listHypervisorCapabilities`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhypervisorcapabilitiesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      hypervisorCapabilities:
                        type: array
                        items:
                          $ref: '#/components/schemas/HypervisorCapability'
                    additionalProperties: true
                required:
                - listhypervisorcapabilitiesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhypervisorcapabilitiesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listhypervisorcapabilitiesresponse
      x-cloudstack-command: listHypervisorCapabilities
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
  /listHypervisors:
    get:
      operationId: listHypervisors
      summary: List hypervisors
      tags:
      - Hypervisor
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listHypervisors
          default: listHypervisors
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The zone id for listing hypervisors.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listHypervisors`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhypervisorsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      hypervisor:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListDeploymentPlannersResult'
                    additionalProperties: true
                required:
                - listhypervisorsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listhypervisorsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listhypervisorsresponse
      x-cloudstack-command: listHypervisors
      x-cloudstack-async: false
  /listImageStoreObjects:
    get:
      operationId: listImageStoreObjects
      summary: Lists objects at specified path on an image store.
      tags:
      - ImageStoreObject
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listImageStoreObjects
          default: listImageStoreObjects
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: id of the image store
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - listSwifts
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: path
        in: query
        description: path to list on image store
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listImageStoreObjects`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listimagestoreobjectsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id233
                        $ref: '#/components/schemas/ListImageStoreObjectsResult'
                      - type: array
                        items: *id233
                required:
                - listimagestoreobjectsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listimagestoreobjectsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listimagestoreobjectsresponse
      x-cloudstack-command: listImageStoreObjects
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /listImageStores:
    get:
      operationId: listImageStores
      summary: Lists image stores.
      tags:
      - ImageStore
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listImageStores
          default: listImageStores
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - addSwift
        - listImageStores
        - listSwifts
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the image store
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: protocol
        in: query
        description: The image store protocol
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: The image store provider
        schema:
          type: string
          maxLength: 255
      - name: readonly
        in: query
        description: Read-only status of the image store
        schema:
          type: boolean
        x-cloudstack-since: 4.15.0
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - addSwift
        - listImageStores
        - listSwifts
      - name: zoneid
        in: query
        description: The Zone ID for the image store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listImageStores`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listimagestoresresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      imagestore:
                        type: array
                        items:
                          $ref: '#/components/schemas/ImageStore'
                    additionalProperties: true
                required:
                - listimagestoresresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listimagestoresresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listimagestoresresponse
      x-cloudstack-command: listImageStores
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - addImageStore
      - addSecondaryStorage
      - addSwift
      - listSwifts
  /listImportVmTasks:
    get:
      operationId: listImportVmTasks
      summary: List running import virtual machine tasks from a unmanaged hosts into CloudStack
      tags:
      - ImportVmTask
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listImportVmTasks
          default: listImportVmTasks
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: the zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: accountid
        in: query
        description: the ID of the Account
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - enableAccount
        - listAccounts
      - name: convertinstancehostid
        in: query
        description: Conversion host of the importing task
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: tasksfilter
        in: query
        description: 'Filter tasks by state, valid options are: All, Running, Completed, Failed'
        schema:
          type: string
          maxLength: 255
      - name: vcenter
        in: query
        description: The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listImportVmTasks`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listimportvmtasksresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id234
                        $ref: '#/components/schemas/ImportVmTask'
                      - type: array
                        items: *id234
                required:
                - listimportvmtasksresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listimportvmtasksresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listimportvmtasksresponse
      x-cloudstack-command: listImportVmTasks
      x-cloudstack-async: false
      x-cloudstack-since: '4.22'
  /listInfrastructure:
    get:
      operationId: listInfrastructure
      summary: Lists infrastructure
      tags:
      - Infrastructure
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listInfrastructure
          default: listInfrastructure
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `listInfrastructure`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listinfrastructureresponse:
                    type: object
                    properties:
                      infrastructure:
                        $ref: '#/components/schemas/Infrastructure'
                    additionalProperties: true
                required:
                - listinfrastructureresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listinfrastructureresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listinfrastructureresponse
      x-cloudstack-command: listInfrastructure
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.3
  /listInstanceGroups:
    get:
      operationId: listInstanceGroups
      summary: Lists Instance groups
      tags:
      - InstanceGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listInstanceGroups
          default: listInstanceGroups
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: id
        in: query
        description: List Instance groups by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createInstanceGroup
        - listInstanceGroups
        - updateInstanceGroup
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: List Instance groups by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `listInstanceGroups`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listinstancegroupsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id235
                        $ref: '#/components/schemas/InstanceGroup'
                      - type: array
                        items: *id235
                required:
                - listinstancegroupsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listinstancegroupsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listinstancegroupsresponse
      x-cloudstack-command: listInstanceGroups
      x-cloudstack-async: false
      x-cloudstack-related:
      - createInstanceGroup
      - updateInstanceGroup
  /listInternalLoadBalancerElements:
    get:
      operationId: listInternalLoadBalancerElements
      summary: Lists all available Internal Load Balancer elements.
      tags:
      - InternalLoadBalancerElement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listInternalLoadBalancerElements
          default: listInternalLoadBalancerElements
      - $ref: '#/components/parameters/response'
      - name: enabled
        in: query
        description: List internal load balancer elements by enabled state
        schema:
          type: boolean
      - name: id
        in: query
        description: List internal load balancer elements by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listInternalLoadBalancerElements
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: nspid
        in: query
        description: List internal load balancer elements by network service provider ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetworkServiceProvider
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listInternalLoadBalancerElements`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listinternalloadbalancerelementsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      internalloadbalancerelement:
                        type: array
                        items:
                          $ref: '#/components/schemas/InternalLoadBalancerElement'
                    additionalProperties: true
                required:
                - listinternalloadbalancerelementsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listinternalloadbalancerelementsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listinternalloadbalancerelementsresponse
      x-cloudstack-command: listInternalLoadBalancerElements
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
  /listInternalLoadBalancerVMs:
    get:
      operationId: listInternalLoadBalancerVMs
      summary: List internal LB Instances.
      tags:
      - InternalLoadBalancerVM
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listInternalLoadBalancerVMs
          default: listInternalLoadBalancerVMs
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fetchhealthcheckresults
        in: query
        description: If true is passed for this parameter, also fetch last executed health check results for the Instance. Default is false
        schema:
          type: boolean
        x-cloudstack-since: '4.14'
      - name: forvpc
        in: query
        description: If true is passed for this parameter, list only VPC Internal LB Instances
        schema:
          type: boolean
      - name: hostid
        in: query
        description: The host ID of the Internal LB Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: id
        in: query
        description: The ID of the Internal LB Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the Internal LB Instance
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: List by Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The Pod ID of the Internal LB Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: state
        in: query
        description: The state of the Internal LB Instance
        schema:
          type: string
          maxLength: 255
      - name: vpcid
        in: query
        description: List Internal LB Instances by VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: zoneid
        in: query
        description: The Zone ID of the Internal LB Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listInternalLoadBalancerVMs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listinternalloadbalancervmsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id236
                        $ref: '#/components/schemas/Router'
                      - type: array
                        items: *id236
                required:
                - listinternalloadbalancervmsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listinternalloadbalancervmsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listinternalloadbalancervmsresponse
      x-cloudstack-command: listInternalLoadBalancerVMs
      x-cloudstack-async: false
      x-cloudstack-related:
      - listRouters
  /listIpForwardingRules:
    get:
      operationId: listIpForwardingRules
      summary: List the IP forwarding rules
      tags:
      - IpForwardingRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listIpForwardingRules
          default: listIpForwardingRules
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: Lists rule with the specified ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: ipaddressid
        in: query
        description: List the rule belonging to this public IP address
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: virtualmachineid
        in: query
        description: Lists all rules applied to the specified Instance.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `listIpForwardingRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listipforwardingrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id237
                        $ref: '#/components/schemas/Ipv6FirewallRule'
                      - type: array
                        items: *id237
                required:
                - listipforwardingrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listipforwardingrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listipforwardingrulesresponse
      x-cloudstack-command: listIpForwardingRules
      x-cloudstack-async: false
      x-cloudstack-related:
      - createIpForwardingRule
      - createIpv6FirewallRule
      - createPortForwardingRule
      - createRoutingFirewallRule
      - listPortForwardingRules
      - listRoutingFirewallRules
      - updateIpv6FirewallRule
      - updatePortForwardingRule
  /listIpv4SubnetsForGuestNetwork:
    get:
      operationId: listIpv4SubnetsForGuestNetwork
      summary: Lists IPv4 subnets for guest networks.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listIpv4SubnetsForGuestNetwork
          default: listIpv4SubnetsForGuestNetwork
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: UUID of the IPv4 subnet for guest network.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpv4SubnetForGuestNetwork
        - listIpv4SubnetsForGuestNetwork
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: UUID of network to which the IPv4 subnet is associated to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: parentid
        in: query
        description: UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpv4SubnetForZone
        - dedicateIpv4SubnetForZone
        - listIpv4SubnetsForZone
        - releaseIpv4SubnetForZone
      - name: subnet
        in: query
        description: The CIDR of the Ipv4 subnet.
        schema:
          type: string
          maxLength: 255
      - name: vpcid
        in: query
        description: UUID of VPC to which the IPv4 subnet is associated to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      - name: zoneid
        in: query
        description: UUID of zone to which the IPv4 subnet belongs to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `listIpv4SubnetsForGuestNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listipv4subnetsforguestnetworkresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id238
                        $ref: '#/components/schemas/CreateIpv4SubnetForGuestNetworkResult'
                      - type: array
                        items: *id238
                required:
                - listipv4subnetsforguestnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listipv4subnetsforguestnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listipv4subnetsforguestnetworkresponse
      x-cloudstack-command: listIpv4SubnetsForGuestNetwork
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createIpv4SubnetForGuestNetwork
  /listIpv4SubnetsForZone:
    get:
      operationId: listIpv4SubnetsForZone
      summary: Lists IPv4 subnets for zone.
      tags:
      - Ipv4SubnetsForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listIpv4SubnetsForZone
          default: listIpv4SubnetsForZone
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: the account which the IPv4 subnet is dedicated to. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: the domain ID which the IPv4 subnet is dedicated to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: UUID of the IPv4 subnet.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - dedicateIpv4SubnetForZone
        - listIpv4SubnetsForZone
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: project who which the IPv4 subnet is dedicated to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: subnet
        in: query
        description: CIDR of the IPv4 subnet.
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: UUID of zone to which the IPv4 subnet belongs to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listIpv4SubnetsForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listipv4subnetsforzoneresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id239
                        $ref: '#/components/schemas/Ipv4SubnetForZone'
                      - type: array
                        items: *id239
                required:
                - listipv4subnetsforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listipv4subnetsforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listipv4subnetsforzoneresponse
      x-cloudstack-command: listIpv4SubnetsForZone
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - dedicateIpv4SubnetForZone
  /listIpv6FirewallRules:
    get:
      operationId: listIpv6FirewallRules
      summary: Lists all IPv6 firewall rules
      tags:
      - Ipv6FirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listIpv6FirewallRules
          default: listIpv6FirewallRules
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
      - name: id
        in: query
        description: Lists IPv6 firewall rule with the specified ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listIpv6FirewallRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: networkid
        in: query
        description: List IPV6 firewall rules by Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: traffictype
        in: query
        description: List IPV6 firewall rules by traffic type - ingress or egress
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listIpv6FirewallRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listipv6firewallrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id240
                        $ref: '#/components/schemas/Ipv6FirewallRule'
                      - type: array
                        items: *id240
                required:
                - listipv6firewallrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listipv6firewallrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listipv6firewallrulesresponse
      x-cloudstack-command: listIpv6FirewallRules
      x-cloudstack-async: false
      x-cloudstack-related:
      - createIpForwardingRule
      - createIpv6FirewallRule
      - createPortForwardingRule
      - createRoutingFirewallRule
      - listIpForwardingRules
      - listPortForwardingRules
      - listRoutingFirewallRules
      - updateIpv6FirewallRule
      - updatePortForwardingRule
  /listIsoPermissions:
    get:
      operationId: listIsoPermissions
      summary: List ISO visibility and all accounts that have permissions to view this ISO.
      tags:
      - IsoPermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listIsoPermissions
          default: listIsoPermissions
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The Template ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listIsoPermissions
        - listTemplatePermissions
      responses:
        '200':
          description: Successful invocation of `listIsoPermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listisopermissionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id241
                        $ref: '#/components/schemas/ListIsoPermissionsResult'
                      - type: array
                        items: *id241
                required:
                - listisopermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listisopermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listisopermissionsresponse
      x-cloudstack-command: listIsoPermissions
      x-cloudstack-async: false
      x-cloudstack-related:
      - listIsoPermissions
      - listTemplatePermissions
  /listIsos:
    get:
      operationId: listIsos
      summary: Lists all available ISO files.
      tags:
      - Iso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listIsos
          default: listIsos
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the ISO. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: bootable
        in: query
        description: True if the ISO is bootable, false otherwise
        schema:
          type: boolean
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: hypervisor
        in: query
        description: The hypervisor for which to restrict the search
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: List ISO by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: imagestoreid
        in: query
        description: ID of the image or image cache store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.19'
        x-cloudstack-related:
        - listSwifts
      - name: isofilter
        in: query
        description: 'Possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : Templates that have been marked as featured and public. * self : Templates that have been registered or created by the calling User. * selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. * sharedexecutable : Templates ready to be deployed that have been granted to the calling User by another User. * executable : Templates that are owned by the calling User, or public Templates, that can be used to deploy an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).'
        schema:
          type: string
          maxLength: 255
      - name: ispublic
        in: query
        description: True if the ISO is publicly available to all Users, false otherwise.
        schema:
          type: boolean
      - name: isready
        in: query
        description: If True, list ISOs that are ready to be deployed.
        schema:
          type: boolean
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: List all ISOs by name
        schema:
          type: string
          maxLength: 255
      - name: oscategoryid
        in: query
        description: the ID of the OS category for the ISO
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listOsCategories
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: showicon
        in: query
        description: Flag to display the resource image for the ISOs
        schema:
          type: boolean
      - name: showremoved
        in: query
        description: Show removed ISOs as well
        schema:
          type: boolean
      - name: showunique
        in: query
        description: If set to true, list only unique ISOs across zones
        schema:
          type: boolean
        x-cloudstack-since: 4.13.2
      - name: storageid
        in: query
        description: ID of the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.19'
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: zoneid
        in: query
        description: The ID of the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listIsos`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listisosresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id242
                        $ref: '#/components/schemas/Template'
                      - type: array
                        items: *id242
                required:
                - listisosresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listisosresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listisosresponse
      x-cloudstack-command: listIsos
      x-cloudstack-async: false
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateVnfTemplate
  /listKMSKeys:
    get:
      operationId: listKMSKeys
      summary: Lists KMS keys available to the caller
      tags:
      - KMSKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listKMSKeys
          default: listKMSKeys
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: enabled
        in: query
        description: Filter by enabled status
        schema:
          type: boolean
      - name: hsmprofileid
        in: query
        description: Filter by HSM profile ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createHSMProfile
        - listHSMProfiles
        - updateHSMProfile
      - name: id
        in: query
        description: List KMS key by UUID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKMSKey
        - listKMSKeys
        - updateKMSKey
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: zoneid
        in: query
        description: Filter by zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listKMSKeys`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listkmskeysresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id243
                        $ref: '#/components/schemas/KMSKey'
                      - type: array
                        items: *id243
                required:
                - listkmskeysresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listkmskeysresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listkmskeysresponse
      x-cloudstack-command: listKMSKeys
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createKMSKey
      - updateKMSKey
  /listKubernetesClusters:
    get:
      operationId: listKubernetesClusters
      summary: Lists Kubernetes clusters
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listKubernetesClusters
          default: listKubernetesClusters
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: clustertype
        in: query
        description: 'Type of the cluster: CloudManaged, ExternalManaged'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKubernetesCluster
        - listKubernetesClusters
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
        - upgradeKubernetesCluster
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: state
        in: query
        description: State of the Kubernetes cluster
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listKubernetesClusters`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listkubernetesclustersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      kubernetescluster:
                        type: array
                        items:
                          $ref: '#/components/schemas/KubernetesCluster'
                    additionalProperties: true
                required:
                - listkubernetesclustersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listkubernetesclustersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listkubernetesclustersresponse
      x-cloudstack-command: listKubernetesClusters
      x-cloudstack-async: false
      x-cloudstack-related:
      - createKubernetesCluster
      - scaleKubernetesCluster
      - startKubernetesCluster
      - updateKubernetesClusterAffinityGroups
      - upgradeKubernetesCluster
  /listKubernetesSupportedVersions:
    get:
      operationId: listKubernetesSupportedVersions
      summary: Lists supported Kubernetes version
      tags:
      - KubernetesSupportedVersion
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listKubernetesSupportedVersions
          default: listKubernetesSupportedVersions
      - $ref: '#/components/parameters/response'
      - name: arch
        in: query
        description: 'the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: id
        in: query
        description: The ID of the Kubernetes supported version
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - getUploadParamsForKubernetesSupportedVersion
        - listKubernetesSupportedVersions
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: minimumkubernetesversionid
        in: query
        description: The ID of the minimum Kubernetes supported version
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - getUploadParamsForKubernetesSupportedVersion
        - listKubernetesSupportedVersions
      - name: minimumsemanticversion
        in: query
        description: The minimum semantic version for the Kubernetes supported version to be listed
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of the zone in which Kubernetes supported version will be available
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listKubernetesSupportedVersions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listkubernetessupportedversionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      kubernetessupportedversion:
                        type: array
                        items:
                          $ref: '#/components/schemas/KubernetesSupportedVersion'
                    additionalProperties: true
                required:
                - listkubernetessupportedversionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listkubernetessupportedversionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listkubernetessupportedversionsresponse
      x-cloudstack-command: listKubernetesSupportedVersions
      x-cloudstack-async: false
      x-cloudstack-related:
      - getUploadParamsForKubernetesSupportedVersion
  /listLBHealthCheckPolicies:
    get:
      operationId: listLBHealthCheckPolicies
      summary: Lists load balancer health check policies.
      tags:
      - LBHealthCheckPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listLBHealthCheckPolicies
          default: listLBHealthCheckPolicies
      - $ref: '#/components/parameters/response'
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: The ID of the health check policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - createLBHealthCheckPolicy
        - listLBHealthCheckPolicies
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: lbruleid
        in: query
        description: The ID of the load balancer rule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listLBHealthCheckPolicies`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listlbhealthcheckpoliciesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id244
                        $ref: '#/components/schemas/LBHealthCheckPolicy'
                      - type: array
                        items: *id244
                required:
                - listlbhealthcheckpoliciesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listlbhealthcheckpoliciesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listlbhealthcheckpoliciesresponse
      x-cloudstack-command: listLBHealthCheckPolicies
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - createLBHealthCheckPolicy
  /listLBStickinessPolicies:
    get:
      operationId: listLBStickinessPolicies
      summary: Lists load balancer stickiness policies.
      tags:
      - LBStickinessPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listLBStickinessPolicies
          default: listLBStickinessPolicies
      - $ref: '#/components/parameters/response'
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: The ID of the load balancer stickiness policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createLBStickinessPolicy
        - listLBStickinessPolicies
        - updateLBStickinessPolicy
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: lbruleid
        in: query
        description: The ID of the load balancer rule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updatePortForwardingRule
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listLBStickinessPolicies`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listlbstickinesspoliciesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id245
                        $ref: '#/components/schemas/LBStickinessPolicy'
                      - type: array
                        items: *id245
                required:
                - listlbstickinesspoliciesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listlbstickinesspoliciesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listlbstickinesspoliciesresponse
      x-cloudstack-command: listLBStickinessPolicies
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - createLBStickinessPolicy
      - updateLBStickinessPolicy
  /listLdapConfigurations:
    get:
      operationId: listLdapConfigurations
      summary: Lists all LDAP configurations
      tags:
      - LdapConfiguration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listLdapConfigurations
          default: listLdapConfigurations
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: Linked Domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: hostname
        in: query
        description: Hostname
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: list ldap configuration by ID; when passed, all other parameters are ignored
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addLdapConfiguration
        - listLdapConfigurations
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to true, and no `domainid` specified, list all LDAP configurations irrespective of the linked domain
        schema:
          type: boolean
        x-cloudstack-since: 4.13.2
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: port
        in: query
        description: Port
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listLdapConfigurations`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listldapconfigurationsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id246
                        $ref: '#/components/schemas/LdapConfiguration'
                      - type: array
                        items: *id246
                required:
                - listldapconfigurationsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listldapconfigurationsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listldapconfigurationsresponse
      x-cloudstack-command: listLdapConfigurations
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - addLdapConfiguration
  /listLdapUsers:
    get:
      operationId: listLdapUsers
      summary: Lists LDAP Users according to the specifications from the user request.
      tags:
      - LdapUser
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listLdapUsers
          default: listLdapUsers
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: Linked Domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listtype
        in: query
        description: Determines whether all ldap users are returned or just non-cloudstack users. This option is deprecated in favour for the more option rich 'userfilter' parameter
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: userfilter
        in: query
        description: "Determines what type of filter is applied on the list of users returned from LDAP.\n\tvalid values are\n\t'NoFilter'\t no filtering is done,\n\t'LocalDomain'\tusers already in the current or requested domain will be filtered out of the result list,\n\t'AnyDomain'\tusers that already exist anywhere in cloudstack will be filtered out, and\n\t'PotentialImport'\tall users that would be automatically imported from the listing will be shown, including those that are already in cloudstack, the later will be annotated with their userSource"
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.13'
      responses:
        '200':
          description: Successful invocation of `listLdapUsers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listldapusersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id247
                        $ref: '#/components/schemas/LdapUser'
                      - type: array
                        items: *id247
                required:
                - listldapusersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listldapusersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listldapusersresponse
      x-cloudstack-command: listLdapUsers
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - importLdapUsers
      - searchLdap
  /listLoadBalancerRuleInstances:
    get:
      operationId: listLoadBalancerRuleInstances
      summary: List all Instances that are assigned to a load balancer rule.
      tags:
      - LoadBalancerRuleInstance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listLoadBalancerRuleInstances
          default: listLoadBalancerRuleInstances
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPortForwardingRule
        - updatePortForwardingRule
      - name: applied
        in: query
        description: True if listing all Instances currently applied to the load balancer rule; default is true
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: lbvmips
        in: query
        description: True if load balancer rule Instance IP information to be included; default is false
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listLoadBalancerRuleInstances`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listloadbalancerruleinstancesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id248
                        $ref: '#/components/schemas/LoadBalancerRuleInstance'
                      - type: array
                        items: *id248
                required:
                - listloadbalancerruleinstancesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listloadbalancerruleinstancesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listloadbalancerruleinstancesresponse
      x-cloudstack-command: listLoadBalancerRuleInstances
      x-cloudstack-async: false
      x-cloudstack-related:
      - listLoadBalancerRuleInstances
  /listLoadBalancerRules:
    get:
      operationId: listLoadBalancerRules
      summary: Lists load balancer rules.
      tags:
      - LoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listLoadBalancerRules
          default: listLoadBalancerRules
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: The ID of the load balancer rule
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the load balancer rule
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: List by Network ID the rule belongs to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: publicipid
        in: query
        description: The public IP address ID of the load balancer rule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: virtualmachineid
        in: query
        description: The ID of the  Instance of the load balancer rule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: zoneid
        in: query
        description: The availability zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listLoadBalancerRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listloadbalancerrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      loadbalancerrule:
                        type: array
                        items:
                          $ref: '#/components/schemas/LoadBalancerRule'
                    additionalProperties: true
                required:
                - listloadbalancerrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listloadbalancerrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listloadbalancerrulesresponse
      x-cloudstack-command: listLoadBalancerRules
      x-cloudstack-async: false
  /listLoadBalancers:
    get:
      operationId: listLoadBalancers
      summary: Lists internal load balancers
      tags:
      - LoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listLoadBalancers
          default: listLoadBalancers
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: The ID of the load balancer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the load balancer
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: The network ID of the load balancer
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      - name: scheme
        in: query
        description: The scheme of the load balancer. Supported value is internal in the current release
        schema:
          type: string
          maxLength: 255
      - name: sourceipaddress
        in: query
        description: The source IP address of the load balancer
        schema:
          type: string
          maxLength: 255
      - name: sourceipaddressnetworkid
        in: query
        description: The network ID of the source IP address
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `listLoadBalancers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listloadbalancersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id249
                        $ref: '#/components/schemas/LoadBalancer'
                      - type: array
                        items: *id249
                required:
                - listloadbalancersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listloadbalancersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listloadbalancersresponse
      x-cloudstack-command: listLoadBalancers
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - createLoadBalancer
  /listManagementServers:
    get:
      operationId: listManagementServers
      summary: Lists management servers.
      tags:
      - ManagementServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listManagementServers
          default: listManagementServers
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listManagementServers
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the management server
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: peers
        in: query
        description: Whether to return the management server peers or not. By default, the management server peers will not be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.1.0
      - name: version
        in: query
        description: the version of the management server
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.3
      responses:
        '200':
          description: Successful invocation of `listManagementServers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listmanagementserversresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      managementserver:
                        type: array
                        items:
                          $ref: '#/components/schemas/ManagementServer'
                    additionalProperties: true
                required:
                - listmanagementserversresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listmanagementserversresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listmanagementserversresponse
      x-cloudstack-command: listManagementServers
      x-cloudstack-async: false
  /listManagementServersMetrics:
    get:
      operationId: listManagementServersMetrics
      summary: Lists Management Server metrics
      tags:
      - ManagementServersMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listManagementServersMetrics
          default: listManagementServersMetrics
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listManagementServers
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the management server
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: peers
        in: query
        description: Whether to return the management server peers or not. By default, the management server peers will not be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.20.1.0
      - name: system
        in: query
        description: Include system level stats
        schema:
          type: boolean
        x-cloudstack-related:
        - listManagementServersMetrics
      - name: version
        in: query
        description: the version of the management server
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.3
      responses:
        '200':
          description: Successful invocation of `listManagementServersMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listmanagementserversmetricsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      managementserver:
                        type: array
                        items:
                          $ref: '#/components/schemas/ManagementServersMetric'
                    additionalProperties: true
                required:
                - listmanagementserversmetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listmanagementserversmetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listmanagementserversmetricsresponse
      x-cloudstack-command: listManagementServersMetrics
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /listNetscalerControlCenter:
    get:
      operationId: listNetscalerControlCenter
      summary: List control center
      tags:
      - NetscalerControlCenter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetscalerControlCenter
          default: listNetscalerControlCenter
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listNetscalerControlCenter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetscalercontrolcenterresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id250
                        $ref: '#/components/schemas/NetscalerControlCenter'
                      - type: array
                        items: *id250
                required:
                - listnetscalercontrolcenterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetscalercontrolcenterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetscalercontrolcenterresponse
      x-cloudstack-command: listNetscalerControlCenter
      x-cloudstack-async: false
  /listNetscalerLoadBalancerNetworks:
    get:
      operationId: listNetscalerLoadBalancerNetworks
      summary: Lists network that are using a netscaler load balancer device
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetscalerLoadBalancerNetworks
          default: listNetscalerLoadBalancerNetworks
      - $ref: '#/components/parameters/response'
      - name: lbdeviceid
        in: query
        description: Netscaler load balancer device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetscalerLoadBalancer
        - configureNetscalerLoadBalancer
        - deployNetscalerVpx
        - listNetscalerLoadBalancers
        - registerNetscalerControlCenter
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listNetscalerLoadBalancerNetworks`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetscalerloadbalancernetworksresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id251
                        $ref: '#/components/schemas/Network'
                      - type: array
                        items: *id251
                required:
                - listnetscalerloadbalancernetworksresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetscalerloadbalancernetworksresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetscalerloadbalancernetworksresponse
      x-cloudstack-command: listNetscalerLoadBalancerNetworks
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetwork
      - listBrocadeVcsDeviceNetworks
      - listNetworks
      - listPaloAltoFirewallNetworks
      - migrateNetwork
      - updateNetwork
  /listNetscalerLoadBalancers:
    get:
      operationId: listNetscalerLoadBalancers
      summary: Lists netscaler load balancer devices
      tags:
      - NetscalerLoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetscalerLoadBalancers
          default: listNetscalerLoadBalancers
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: lbdeviceid
        in: query
        description: Netscaler load balancer device ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetscalerLoadBalancer
        - configureNetscalerLoadBalancer
        - deployNetscalerVpx
        - listNetscalerLoadBalancers
        - registerNetscalerControlCenter
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listPhysicalNetworks
        - updatePhysicalNetwork
      responses:
        '200':
          description: Successful invocation of `listNetscalerLoadBalancers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetscalerloadbalancersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id252
                        $ref: '#/components/schemas/NetscalerLoadBalancer'
                      - type: array
                        items: *id252
                required:
                - listnetscalerloadbalancersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetscalerloadbalancersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetscalerloadbalancersresponse
      x-cloudstack-command: listNetscalerLoadBalancers
      x-cloudstack-async: false
      x-cloudstack-related:
      - addNetscalerLoadBalancer
      - configureNetscalerLoadBalancer
      - deployNetscalerVpx
      - registerNetscalerControlCenter
  /listNetworkACLLists:
    get:
      operationId: listNetworkACLLists
      summary: Lists all network ACLs
      tags:
      - NetworkACLList
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworkACLLists
          default: listNetworkACLLists
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: Lists network ACL with the specified ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
        - listNetworkACLLists
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: List network ACLs by specified name
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: List network ACLs by network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: vpcid
        in: query
        description: List network ACLs by VPC ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `listNetworkACLLists`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkacllistsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      networkacllist:
                        type: array
                        items:
                          $ref: '#/components/schemas/NetworkACLList'
                    additionalProperties: true
                required:
                - listnetworkacllistsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkacllistsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworkacllistsresponse
      x-cloudstack-command: listNetworkACLLists
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetworkACLList
  /listNetworkACLs:
    get:
      operationId: listNetworkACLs
      summary: Lists all network ACL items
      tags:
      - NetworkACL
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworkACLs
          default: listNetworkACLs
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: aclid
        in: query
        description: List network ACL items by ACL ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
        - listNetworkACLLists
      - name: action
        in: query
        description: List network ACL items by action
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: Lists network ACL Item with the specified ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACL
        - importNetworkACL
        - listNetworkACLs
        - moveNetworkAclItem
        - updateNetworkACLItem
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: networkid
        in: query
        description: List network ACL items by network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: protocol
        in: query
        description: List network ACL items by protocol
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: traffictype
        in: query
        description: List network ACL items by traffic type - ingress or egress
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listNetworkACLs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkaclsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      networkacl:
                        type: array
                        items:
                          $ref: '#/components/schemas/NetworkACL'
                    additionalProperties: true
                required:
                - listnetworkaclsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkaclsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworkaclsresponse
      x-cloudstack-command: listNetworkACLs
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetworkACL
      - importNetworkACL
      - moveNetworkAclItem
      - updateNetworkACLItem
  /listNetworkDevice:
    get:
      operationId: listNetworkDevice
      summary: List network devices
      tags:
      - NetworkDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworkDevice
          default: listNetworkDevice
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: networkdeviceparameterlist
        in: query
        description: Parameters for network device. Map parameter. CloudStack expects it index-encoded as `networkdeviceparameterlist[0].key=k&networkdeviceparameterlist[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: networkdevicetype
        in: query
        description: Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listNetworkDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkdeviceresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id253
                        $ref: '#/components/schemas/NetworkDevice'
                      - type: array
                        items: *id253
                required:
                - listnetworkdeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkdeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworkdeviceresponse
      x-cloudstack-command: listNetworkDevice
      x-cloudstack-async: false
      x-cloudstack-related:
      - addNetworkDevice
  /listNetworkIsolationMethods:
    get:
      operationId: listNetworkIsolationMethods
      summary: Lists supported methods of network isolation
      tags:
      - NetworkIsolationMethod
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworkIsolationMethods
          default: listNetworkIsolationMethods
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listNetworkIsolationMethods`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkisolationmethodsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      isolationmethod:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListDeploymentPlannersResult'
                    additionalProperties: true
                required:
                - listnetworkisolationmethodsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkisolationmethodsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworkisolationmethodsresponse
      x-cloudstack-command: listNetworkIsolationMethods
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
  /listNetworkOfferings:
    get:
      operationId: listNetworkOfferings
      summary: Lists all available network offerings.
      tags:
      - NetworkOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworkOfferings
          default: listNetworkOfferings
      - $ref: '#/components/parameters/response'
      - name: availability
        in: query
        description: The availability of network offering. Default value is required
        schema:
          type: string
          maxLength: 255
      - name: displaytext
        in: query
        description: List network offerings by display text
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List network offerings available for network creation in specific domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - listDomains
      - name: forvpc
        in: query
        description: The network offering can be used only for network creation inside the VPC
        schema:
          type: boolean
      - name: guestiptype
        in: query
        description: 'List network offerings by guest type: shared or isolated'
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: List network offerings by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listNetworkOfferings
      - name: isdefault
        in: query
        description: True if need to list only default network offerings. Default value is false
        schema:
          type: boolean
      - name: istagged
        in: query
        description: True if offering has tags specified
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List network offerings by name
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: The ID of the network. Pass this in if you want to see the available network offering that a network can be changed to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: routingmode
        in: query
        description: 'the routing mode for the network offering. Supported types are: Static or Dynamic.'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: sourcenatsupported
        in: query
        description: True if need to list only netwok offerings where source NAT is supported, false otherwise
        schema:
          type: boolean
      - name: specifyipranges
        in: query
        description: True if need to list only network offerings which support specifying ip ranges
        schema:
          type: boolean
      - name: specifyvlan
        in: query
        description: The tags for the network offering.
        schema:
          type: boolean
      - name: state
        in: query
        description: List network offerings by state
        schema:
          type: string
          maxLength: 255
      - name: supportedservices
        in: query
        description: List network offerings supporting certain services. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: tags
        in: query
        description: List network offerings by tags
        schema:
          type: string
          maxLength: 4096
      - name: traffictype
        in: query
        description: List by traffic type
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: List network offerings available for network creation in specific zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listNetworkOfferings`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkofferingsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      networkoffering:
                        type: array
                        items:
                          $ref: '#/components/schemas/NetworkOffering'
                    additionalProperties: true
                required:
                - listnetworkofferingsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkofferingsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworkofferingsresponse
      x-cloudstack-command: listNetworkOfferings
      x-cloudstack-async: false
  /listNetworkPermissions:
    get:
      operationId: listNetworkPermissions
      summary: List Network visibility and all Accounts that have permissions to view this Network.
      tags:
      - NetworkPermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworkPermissions
          default: listNetworkPermissions
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: Lists Network permission by Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      responses:
        '200':
          description: Successful invocation of `listNetworkPermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkpermissionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id254
                        $ref: '#/components/schemas/NetworkPermission'
                      - type: array
                        items: *id254
                required:
                - listnetworkpermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkpermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworkpermissionsresponse
      x-cloudstack-command: listNetworkPermissions
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /listNetworkProtocols:
    get:
      operationId: listNetworkProtocols
      summary: Lists details of network protocols
      tags:
      - NetworkProtocol
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworkProtocols
          default: listNetworkProtocols
      - $ref: '#/components/parameters/response'
      - name: option
        in: query
        description: 'The option of network protocols. Supported values are: protocolnumber, icmptype.'
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listNetworkProtocols`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkprotocolsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id255
                        $ref: '#/components/schemas/NetworkProtocol'
                      - type: array
                        items: *id255
                required:
                - listnetworkprotocolsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkprotocolsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworkprotocolsresponse
      x-cloudstack-command: listNetworkProtocols
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /listNetworkServiceProviders:
    get:
      operationId: listNetworkServiceProviders
      summary: Lists network serviceproviders for a given physical network.
      tags:
      - NetworkServiceProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworkServiceProviders
          default: listNetworkServiceProviders
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List providers by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: state
        in: query
        description: List providers by state
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listNetworkServiceProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkserviceprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      networkserviceprovider:
                        type: array
                        items:
                          $ref: '#/components/schemas/NetworkServiceProvider'
                    additionalProperties: true
                required:
                - listnetworkserviceprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworkserviceprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworkserviceprovidersresponse
      x-cloudstack-command: listNetworkServiceProviders
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - addNetworkServiceProvider
  /listNetworks:
    get:
      operationId: listNetworks
      summary: Lists all available networks.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNetworks
          default: listNetworks
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: acltype
        in: query
        description: List Networks by ACL (access control list) type. Supported values are Account and domain
        schema:
          type: string
          maxLength: 255
      - name: associatednetworkid
        in: query
        description: List networks by associated networks. Only available if create a Shared network.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.17.0
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: canusefordeploy
        in: query
        description: List networks available for Instance deployment
        schema:
          type: boolean
      - name: displaynetwork
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: forvpc
        in: query
        description: The network belongs to VPC
        schema:
          type: boolean
      - name: id
        in: query
        description: List Networks by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: issystem
        in: query
        description: True if Network is system, false otherwise
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: list networks by name
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.22.0
      - name: networkfilter
        in: query
        description: 'Possible values are "account", "domain", "accountdomain","shared", and "all". Default value is "all".* account : account networks that have been registered for or created by the calling User. * domain : domain networks that have been registered for or created by the calling User. * accountdomain : account and domain networks that have been registered for or created by the calling User. * shared : networks that have been granted to the calling User by another User. * all : all networks (account, domain and shared).'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.17.0
      - name: networkofferingid
        in: query
        description: List networks by network offering ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkOffering
        - listNetworkOfferings
        - updateNetworkOffering
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: List Networks by physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: restartrequired
        in: query
        description: List networks by restartRequired
        schema:
          type: boolean
      - name: retrieveonlyresourcecount
        in: query
        description: Makes the API's response contains only the resource count
        schema:
          type: boolean
      - name: showicon
        in: query
        description: Flag to display the resource icon for networks
        schema:
          type: boolean
      - name: specifyipranges
        in: query
        description: True if need to list only networks which support specifying IP ranges
        schema:
          type: boolean
      - name: supportedservices
        in: query
        description: List Networks supporting certain services. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: traffictype
        in: query
        description: Type of the traffic
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: 'The type of the Network. Supported values are: isolated, l2, shared and all'
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: The ID or VID of the network
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.17.0
      - name: vpcid
        in: query
        description: List networks by VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: zoneid
        in: query
        description: The zone ID of the Network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listNetworks`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworksresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      network:
                        type: array
                        items:
                          $ref: '#/components/schemas/Network'
                    additionalProperties: true
                required:
                - listnetworksresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnetworksresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnetworksresponse
      x-cloudstack-command: listNetworks
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetwork
      - listNetworks
      - listPaloAltoFirewallNetworks
      - migrateNetwork
      - updateNetwork
  /listNiciraNvpDeviceNetworks:
    get:
      operationId: listNiciraNvpDeviceNetworks
      summary: Lists network that are using a nicira nvp device
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNiciraNvpDeviceNetworks
          default: listNiciraNvpDeviceNetworks
      - $ref: '#/components/parameters/response'
      - name: nvpdeviceid
        in: query
        description: nicira nvp device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNiciraNvpDevice
        - listNiciraNvpDevices
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listNiciraNvpDeviceNetworks`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listniciranvpdevicenetworksresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id256
                        $ref: '#/components/schemas/Network'
                      - type: array
                        items: *id256
                required:
                - listniciranvpdevicenetworksresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listniciranvpdevicenetworksresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listniciranvpdevicenetworksresponse
      x-cloudstack-command: listNiciraNvpDeviceNetworks
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetwork
      - listBrocadeVcsDeviceNetworks
      - listNetscalerLoadBalancerNetworks
      - listNetworks
      - listPaloAltoFirewallNetworks
      - migrateNetwork
      - updateNetwork
  /listNiciraNvpDevices:
    get:
      operationId: listNiciraNvpDevices
      summary: Lists Nicira NVP devices
      tags:
      - NiciraNvpDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNiciraNvpDevices
          default: listNiciraNvpDevices
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: nvpdeviceid
        in: query
        description: nicira nvp device ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNiciraNvpDevice
        - listNiciraNvpDevices
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listNiciraNvpDevices`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listniciranvpdevicesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id257
                        $ref: '#/components/schemas/NiciraNvpDevice'
                      - type: array
                        items: *id257
                required:
                - listniciranvpdevicesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listniciranvpdevicesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listniciranvpdevicesresponse
      x-cloudstack-command: listNiciraNvpDevices
      x-cloudstack-async: false
      x-cloudstack-related:
      - addNiciraNvpDevice
  /listNics:
    get:
      operationId: listNics
      summary: List the Instance NICs IP to NIC
      tags:
      - Nic
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listNics
          default: listNics
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: List NIC of the specific Instance's Network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: nicid
        in: query
        description: The ID of the NIC to list IPs
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listNics
        - updateVmNic
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listNics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnicsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id258
                        $ref: '#/components/schemas/ListNicsResult'
                      - type: array
                        items: *id258
                required:
                - listnicsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listnicsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listnicsresponse
      x-cloudstack-command: listNics
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateVmNic
  /listOauthProvider:
    get:
      operationId: listOauthProvider
      summary: List OAuth providers registered
      tags:
      - OauthProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listOauthProvider
          default: listOauthProvider
      - $ref: '#/components/parameters/response'
      - name: domain
        in: query
        description: Domain path for domain-specific OAuth provider lookup. Ignored when Domain ID is passed.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: domainid
        in: query
        description: Domain ID to list OAuth providers for a specific domain. Use -1 for global providers only.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: id
        in: query
        description: the ID of the OAuth provider
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listOauthProvider
        - updateOauthProvider
        - verifyOAuthCodeAndGetUser
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: provider
        in: query
        description: Name of the provider
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listOauthProvider`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listoauthproviderresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id259
                        $ref: '#/components/schemas/OauthProvider'
                      - type: array
                        items: *id259
                required:
                - listoauthproviderresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listoauthproviderresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listoauthproviderresponse
      x-cloudstack-command: listOauthProvider
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - updateOauthProvider
      - verifyOAuthCodeAndGetUser
  /listObjectStoragePools:
    get:
      operationId: listObjectStoragePools
      summary: Lists object storage pools.
      tags:
      - ObjectStoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listObjectStoragePools
          default: listObjectStoragePools
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addObjectStoragePool
        - listObjectStoragePools
        - updateObjectStoragePool
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: the name of the object store
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: provider
        in: query
        description: the object store provider
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listObjectStoragePools`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listobjectstoragepoolsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id260
                        $ref: '#/components/schemas/ObjectStoragePool'
                      - type: array
                        items: *id260
                required:
                - listobjectstoragepoolsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listobjectstoragepoolsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listobjectstoragepoolsresponse
      x-cloudstack-command: listObjectStoragePools
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - addObjectStoragePool
      - updateObjectStoragePool
  /listOpenDaylightControllers:
    get:
      operationId: listOpenDaylightControllers
      summary: Lists OpenDyalight controllers
      tags:
      - OpenDaylightController
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listOpenDaylightControllers
          default: listOpenDaylightControllers
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of a OpenDaylight Controller
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addOpenDaylightController
        - deleteOpenDaylightController
        - listOpenDaylightControllers
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      responses:
        '200':
          description: Successful invocation of `listOpenDaylightControllers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listopendaylightcontrollersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id261
                        $ref: '#/components/schemas/OpenDaylightController'
                      - type: array
                        items: *id261
                required:
                - listopendaylightcontrollersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listopendaylightcontrollersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listopendaylightcontrollersresponse
      x-cloudstack-command: listOpenDaylightControllers
      x-cloudstack-async: false
      x-cloudstack-related:
      - addOpenDaylightController
      - deleteOpenDaylightController
  /listOsCategories:
    get:
      operationId: listOsCategories
      summary: Lists all supported OS categories for this cloud.
      tags:
      - OsCategory
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listOsCategories
          default: listOsCategories
      - $ref: '#/components/parameters/response'
      - name: arch
        in: query
        description: List OS categories types available for given CPU architecture
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: id
        in: query
        description: List OS category by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listOsCategories
      - name: isfeatured
        in: query
        description: List available OS categories by featured or not
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: isiso
        in: query
        description: List OS categories for which an ISO is available
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: isvnf
        in: query
        description: List OS categories for which a VNF template is available
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List OS category by name
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 3.0.1
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showicon
        in: query
        description: flag to display the resource image for the OS category
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: zoneid
        in: query
        description: List available OS categories types for the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listOsCategories`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listoscategoriesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      oscategory:
                        type: array
                        items:
                          $ref: '#/components/schemas/OsCategory'
                    additionalProperties: true
                required:
                - listoscategoriesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listoscategoriesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listoscategoriesresponse
      x-cloudstack-command: listOsCategories
      x-cloudstack-async: false
  /listOsTypes:
    get:
      operationId: listOsTypes
      summary: Lists all supported OS types for this cloud.
      tags:
      - OsType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listOsTypes
          default: listOsTypes
      - $ref: '#/components/parameters/response'
      - name: description
        in: query
        description: List OS by description
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 3.0.1
      - name: fordisplay
        in: query
        description: list resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: 4.18.1
      - name: id
        in: query
        description: List by OS type ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
        - listOsTypes
      - name: ids
        in: query
        description: Comma separated list of OS types. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.22.1
        x-cloudstack-related:
        - addGuestOs
        - listOsTypes
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: oscategoryid
        in: query
        description: List by OS Category ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addOsCategory
        - listOsCategories
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listOsTypes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listostypesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      ostype:
                        type: array
                        items:
                          $ref: '#/components/schemas/GuestO'
                    additionalProperties: true
                required:
                - listostypesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listostypesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listostypesresponse
      x-cloudstack-command: listOsTypes
      x-cloudstack-async: false
      x-cloudstack-related:
      - addGuestOs
  /listOvsElements:
    get:
      operationId: listOvsElements
      summary: Lists all available ovs elements.
      tags:
      - OvsElement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listOvsElements
          default: listOvsElements
      - $ref: '#/components/parameters/response'
      - name: enabled
        in: query
        description: List network offerings by enabled state
        schema:
          type: boolean
      - name: id
        in: query
        description: List ovs elements by id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - configureOvsElement
        - listOvsElements
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: nspid
        in: query
        description: List ovs elements by network service provider id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetworkServiceProvider
        - listNetworkServiceProviders
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listOvsElements`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listovselementsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id262
                        $ref: '#/components/schemas/VirtualRouterElement'
                      - type: array
                        items: *id262
                required:
                - listovselementsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listovselementsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listovselementsresponse
      x-cloudstack-command: listOvsElements
      x-cloudstack-async: false
      x-cloudstack-related:
      - configureOvsElement
  /listPaloAltoFirewallNetworks:
    get:
      operationId: listPaloAltoFirewallNetworks
      summary: Lists Network that are using Palo Alto firewall device
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listPaloAltoFirewallNetworks
          default: listPaloAltoFirewallNetworks
      - $ref: '#/components/parameters/response'
      - name: lbdeviceid
        in: query
        description: Palo alto balancer device ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - configurePaloAltoFirewall
        - listPaloAltoFirewalls
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listPaloAltoFirewallNetworks`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listpaloaltofirewallnetworksresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id263
                        $ref: '#/components/schemas/Network'
                      - type: array
                        items: *id263
                required:
                - listpaloaltofirewallnetworksresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listpaloaltofirewallnetworksresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listpaloaltofirewallnetworksresponse
      x-cloudstack-command: listPaloAltoFirewallNetworks
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetwork
      - listNetworks
      - migrateNetwork
      - updateNetwork
  /listPaloAltoFirewalls:
    get:
      operationId: listPaloAltoFirewalls
      summary: Lists Palo Alto firewall devices in a physical Network
      tags:
      - PaloAltoFirewall
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listPaloAltoFirewalls
          default: listPaloAltoFirewalls
      - $ref: '#/components/parameters/response'
      - name: fwdeviceid
        in: query
        description: Palo Alto firewall device ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listPaloAltoFirewalls
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listPaloAltoFirewalls`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listpaloaltofirewallsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id264
                        $ref: '#/components/schemas/PaloAltoFirewall'
                      - type: array
                        items: *id264
                required:
                - listpaloaltofirewallsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listpaloaltofirewallsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listpaloaltofirewallsresponse
      x-cloudstack-command: listPaloAltoFirewalls
      x-cloudstack-async: false
  /listPhysicalNetworks:
    get:
      operationId: listPhysicalNetworks
      summary: Lists physical networks
      tags:
      - PhysicalNetwork
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listPhysicalNetworks
          default: listPhysicalNetworks
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: List physical network by id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Search by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The Zone ID for the physical network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listPhysicalNetworks`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listphysicalnetworksresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      physicalnetwork:
                        type: array
                        items:
                          $ref: '#/components/schemas/PhysicalNetwork'
                    additionalProperties: true
                required:
                - listphysicalnetworksresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listphysicalnetworksresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listphysicalnetworksresponse
      x-cloudstack-command: listPhysicalNetworks
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - updatePhysicalNetwork
  /listPods:
    get:
      operationId: listPods
      summary: Lists all Pods.
      tags:
      - Pod
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listPods
          default: listPods
      - $ref: '#/components/parameters/response'
      - name: allocationstate
        in: query
        description: List pods by allocation state
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: List Pods by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - listPods
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List Pods by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showcapacities
        in: query
        description: Flag to display the capacity of the pods
        schema:
          type: boolean
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: zoneid
        in: query
        description: List Pods by Zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listPods`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listpodsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      pod:
                        type: array
                        items:
                          $ref: '#/components/schemas/Pod'
                    additionalProperties: true
                required:
                - listpodsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listpodsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listpodsresponse
      x-cloudstack-command: listPods
      x-cloudstack-async: false
      x-cloudstack-related:
      - createManagementNetworkIpRange
  /listPortForwardingRules:
    get:
      operationId: listPortForwardingRules
      summary: Lists all port forwarding rules for an IP address.
      tags:
      - PortForwardingRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listPortForwardingRules
          default: listPortForwardingRules
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: Lists rule with the specified ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: ipaddressid
        in: query
        description: The ID of IP address of the port forwarding services
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: networkid
        in: query
        description: List port forwarding rules for certain network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.3'
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `listPortForwardingRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listportforwardingrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      portforwardingrule:
                        type: array
                        items:
                          $ref: '#/components/schemas/Ipv6FirewallRule'
                    additionalProperties: true
                required:
                - listportforwardingrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listportforwardingrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listportforwardingrulesresponse
      x-cloudstack-command: listPortForwardingRules
      x-cloudstack-async: false
      x-cloudstack-related:
      - createIpForwardingRule
      - createPortForwardingRule
      - createRoutingFirewallRule
      - listRoutingFirewallRules
      - updateIpv6FirewallRule
      - updatePortForwardingRule
  /listPortableIpRanges:
    get:
      operationId: listPortableIpRanges
      summary: List portable IP ranges
      tags:
      - PortableIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listPortableIpRanges
          default: listPortableIpRanges
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the portable ip range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPortableIpRange
        - listPortableIpRanges
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: regionid
        in: query
        description: Id of a Region
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listPortableIpRanges`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listportableiprangesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id265
                        $ref: '#/components/schemas/PortableIpRange'
                      - type: array
                        items: *id265
                required:
                - listportableiprangesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listportableiprangesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listportableiprangesresponse
      x-cloudstack-command: listPortableIpRanges
      x-cloudstack-async: false
      x-cloudstack-related:
      - createPortableIpRange
  /listPrivateGateways:
    get:
      operationId: listPrivateGateways
      summary: List private gateways
      tags:
      - PrivateGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listPrivateGateways
          default: listPrivateGateways
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: id
        in: query
        description: List private gateway by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPrivateGateway
        - listPrivateGateways
      - name: ipaddress
        in: query
        description: List gateways by IP address
        schema:
          type: string
          maxLength: 255
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: state
        in: query
        description: List gateways by state
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: List gateways by VLAN
        schema:
          type: string
          maxLength: 255
      - name: vpcid
        in: query
        description: List gateways by VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `listPrivateGateways`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprivategatewaysresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id266
                        $ref: '#/components/schemas/PrivateGateway'
                      - type: array
                        items: *id266
                required:
                - listprivategatewaysresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprivategatewaysresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listprivategatewaysresponse
      x-cloudstack-command: listPrivateGateways
      x-cloudstack-async: false
      x-cloudstack-related:
      - createPrivateGateway
      - listPrivateGateways
  /listProjectAccounts:
    get:
      operationId: listProjectAccounts
      summary: Lists project's Accounts
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listProjectAccounts
          default: listProjectAccounts
      - $ref: '#/components/parameters/response'
      - name: projectid
        in: query
        description: ID of the project
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - suspendProject
        - updateProject
      - name: account
        in: query
        description: List Accounts of the project by Account name
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectroleid
        in: query
        description: List Accounts of the project by project role id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectRoles
        - updateProjectRole
      - name: role
        in: query
        description: List Accounts of the project by role
        schema:
          type: string
          maxLength: 255
      - name: userid
        in: query
        description: List invitation by User ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
        - updateUser
      responses:
        '200':
          description: Successful invocation of `listProjectAccounts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectaccountsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id267
                        $ref: '#/components/schemas/Project'
                      - type: array
                        items: *id267
                required:
                - listprojectaccountsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectaccountsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listprojectaccountsresponse
      x-cloudstack-command: listProjectAccounts
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - activateProject
      - createProject
      - suspendProject
      - updateProject
  /listProjectInvitations:
    get:
      operationId: listProjectInvitations
      summary: Lists project invitations and provides detailed information for listed invitations
      tags:
      - ProjectInvitation
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listProjectInvitations
          default: listProjectInvitations
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: activeonly
        in: query
        description: If true, list only active invitations - having Pending state and ones that are not timed out yet
        schema:
          type: boolean
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: id
        in: query
        description: List invitations by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectInvitations
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List by project ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: state
        in: query
        description: List invitations by state
        schema:
          type: string
          maxLength: 255
      - name: userid
        in: query
        description: List invitation by user ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
        - updateUser
      responses:
        '200':
          description: Successful invocation of `listProjectInvitations`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectinvitationsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id268
                        $ref: '#/components/schemas/ProjectInvitation'
                      - type: array
                        items: *id268
                required:
                - listprojectinvitationsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectinvitationsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listprojectinvitationsresponse
      x-cloudstack-command: listProjectInvitations
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
  /listProjectRolePermissions:
    get:
      operationId: listProjectRolePermissions
      summary: Lists a project's project role permissions
      tags:
      - ProjectRolePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listProjectRolePermissions
          default: listProjectRolePermissions
      - $ref: '#/components/parameters/response'
      - name: projectid
        in: query
        description: ID of the project
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: projectroleid
        in: query
        description: ID of the project role
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectRoles
        - updateProjectRole
      responses:
        '200':
          description: Successful invocation of `listProjectRolePermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectrolepermissionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id269
                        $ref: '#/components/schemas/ProjectRolePermission'
                      - type: array
                        items: *id269
                required:
                - listprojectrolepermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectrolepermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listprojectrolepermissionsresponse
      x-cloudstack-command: listProjectRolePermissions
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
  /listProjectRoles:
    get:
      operationId: listProjectRoles
      summary: Lists Project roles in CloudStack
      tags:
      - ProjectRole
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listProjectRoles
          default: listProjectRoles
      - $ref: '#/components/parameters/response'
      - name: projectid
        in: query
        description: List project role by project ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List project role by project role name.
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectroleid
        in: query
        description: List project role by project role ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectRoles
        - updateProjectRole
      responses:
        '200':
          description: Successful invocation of `listProjectRoles`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectrolesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id270
                        $ref: '#/components/schemas/ProjectRole'
                      - type: array
                        items: *id270
                required:
                - listprojectrolesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectrolesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listprojectrolesresponse
      x-cloudstack-command: listProjectRoles
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
      x-cloudstack-related:
      - updateProjectRole
  /listProjects:
    get:
      operationId: listProjects
      summary: Lists projects and provides detailed information for listed projects
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listProjects
          default: listProjects
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: Comma separated list of project details requested, value can be a list of [ all, resource, min]. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: displaytext
        in: query
        description: List projects by display text
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: List projects by project ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: List projects by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showicon
        in: query
        description: Flag to display the resource icon for projects
        schema:
          type: boolean
      - name: state
        in: query
        description: List projects by state
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: List projects by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: username
        in: query
        description: List projects by username
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listProjects`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id271
                        $ref: '#/components/schemas/Project'
                      - type: array
                        items: *id271
                required:
                - listprojectsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listprojectsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listprojectsresponse
      x-cloudstack-command: listProjects
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - activateProject
      - createProject
      - listProjectAccounts
      - suspendProject
      - updateProject
  /listPublicIpAddresses:
    get:
      operationId: listPublicIpAddresses
      summary: Lists all public IP addresses
      tags:
      - IpAddress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listPublicIpAddresses
          default: listPublicIpAddresses
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: allocatedonly
        in: query
        description: Limits search results to allocated public IP addresses
        schema:
          type: boolean
      - name: associatednetworkid
        in: query
        description: Lists all public IP addresses associated to the Network specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: forloadbalancing
        in: query
        description: List only IPs used for load balancing
        schema:
          type: boolean
      - name: forprovider
        in: query
        description: true if range is dedicated for external network provider
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: forsystemvms
        in: query
        description: true if range is dedicated for system VMs
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: forvirtualnetwork
        in: query
        description: The virtual Network for the IP address
        schema:
          type: boolean
      - name: id
        in: query
        description: Lists IP address by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      - name: ipaddress
        in: query
        description: Lists the specified IP address
        schema:
          type: string
          maxLength: 255
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: issourcenat
        in: query
        description: List only source NAT IP addresses
        schema:
          type: boolean
      - name: isstaticnat
        in: query
        description: List only static NAT IP addresses
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: networkid
        in: query
        description: Lists all public IP addresses by source Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.13.0
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: Lists all public IP addresses by physical Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: retrieveonlyresourcecount
        in: query
        description: Makes the API's response contains only the resource count
        schema:
          type: boolean
      - name: state
        in: query
        description: Lists all public IP addresses by state. A comma-separated list of states can be passed.
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: vlanid
        in: query
        description: Lists all public IP addresses by VLAN ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVlanIpRange
        - dedicatePublicIpRange
        - listVlanIpRanges
        - updateVlanIpRange
      - name: vpcid
        in: query
        description: List IPs belonging to the VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      - name: zoneid
        in: query
        description: Lists all public IP addresses by zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listPublicIpAddresses`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listpublicipaddressesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      publicipaddress:
                        type: array
                        items:
                          $ref: '#/components/schemas/IpAddress'
                    additionalProperties: true
                required:
                - listpublicipaddressesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listpublicipaddressesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listpublicipaddressesresponse
      x-cloudstack-command: listPublicIpAddresses
      x-cloudstack-async: false
      x-cloudstack-related:
      - associateIpAddress
      - listPublicIpAddresses
      - reserveIpAddress
      - updateIpAddress
  /listQuarantinedIps:
    get:
      operationId: listQuarantinedIps
      summary: List public IP addresses in quarantine.
      tags:
      - QuarantinedIp
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listQuarantinedIps
          default: listQuarantinedIps
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showinactive
        in: query
        description: Show IPs that are no longer in quarantine.
        schema:
          type: boolean
      - name: showremoved
        in: query
        description: Show IPs removed from quarantine.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `listQuarantinedIps`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listquarantinedipsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id272
                        $ref: '#/components/schemas/QuarantinedIp'
                      - type: array
                        items: *id272
                required:
                - listquarantinedipsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listquarantinedipsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listquarantinedipsresponse
      x-cloudstack-command: listQuarantinedIps
      x-cloudstack-async: false
      x-cloudstack-since: '4.19'
      x-cloudstack-related:
      - updateQuarantinedIp
  /listRegions:
    get:
      operationId: listRegions
      summary: Lists Regions
      tags:
      - Region
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listRegions
          default: listRegions
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: List Region by region ID.
        schema:
          type: integer
          format: int32
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List Region by region name.
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listRegions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listregionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      region:
                        type: array
                        items:
                          $ref: '#/components/schemas/Region'
                    additionalProperties: true
                required:
                - listregionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listregionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listregionsresponse
      x-cloudstack-command: listRegions
      x-cloudstack-async: false
      x-cloudstack-related:
      - addRegion
      - updateRegion
  /listRegisteredServicePackages:
    get:
      operationId: listRegisteredServicePackages
      summary: Lists registered service packages
      tags:
      - RegisteredServicePackage
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listRegisteredServicePackages
          default: listRegisteredServicePackages
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listRegisteredServicePackages`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listregisteredservicepackagesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id273
                        $ref: '#/components/schemas/ListRegisteredServicePackagesResult'
                      - type: array
                        items: *id273
                required:
                - listregisteredservicepackagesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listregisteredservicepackagesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listregisteredservicepackagesresponse
      x-cloudstack-command: listRegisteredServicePackages
      x-cloudstack-async: false
  /listRemoteAccessVpns:
    get:
      operationId: listRemoteAccessVpns
      summary: Lists remote access VPNs
      tags:
      - RemoteAccessVpn
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listRemoteAccessVpns
          default: listRemoteAccessVpns
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: Lists remote access VPN rule with the specified ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.3'
        x-cloudstack-related:
        - listRemoteAccessVpns
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: networkid
        in: query
        description: List remote access VPNs for certain Network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.3'
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: publicipid
        in: query
        description: Public ip address id of the VPN server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - updateIpAddress
      responses:
        '200':
          description: Successful invocation of `listRemoteAccessVpns`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listremoteaccessvpnsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id274
                        $ref: '#/components/schemas/RemoteAccessVpn'
                      - type: array
                        items: *id274
                required:
                - listremoteaccessvpnsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listremoteaccessvpnsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listremoteaccessvpnsresponse
      x-cloudstack-command: listRemoteAccessVpns
      x-cloudstack-async: false
  /listResourceDetails:
    get:
      operationId: listResourceDetails
      summary: List resource detail(s)
      tags:
      - ResourceDetail
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listResourceDetails
          default: listResourceDetails
      - $ref: '#/components/parameters/response'
      - name: resourcetype
        in: query
        description: List by resource type
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: fordisplay
        in: query
        description: If set to true, only details marked with display=true, are returned. False by default
        schema:
          type: boolean
        x-cloudstack-since: '4.3'
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: key
        in: query
        description: List by key
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: resourceid
        in: query
        description: List by resource ID
        schema:
          type: string
          maxLength: 255
      - name: value
        in: query
        description: List by key, value. Needs to be passed only along with key
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `listResourceDetails`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listresourcedetailsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id275
                        $ref: '#/components/schemas/ListResourceDetailsResult'
                      - type: array
                        items: *id275
                required:
                - listresourcedetailsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listresourcedetailsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listresourcedetailsresponse
      x-cloudstack-command: listResourceDetails
      x-cloudstack-async: false
      x-cloudstack-since: '4.2'
  /listResourceIcon:
    get:
      operationId: listResourceIcon
      summary: Lists the resource icon for the specified resource(s)
      tags:
      - ResourceIcon
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listResourceIcon
          default: listResourceIcon
      - $ref: '#/components/parameters/response'
      - name: resourceids
        in: query
        description: List of resources to upload the icon/image for. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listResourceIcon`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listresourceiconresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id276
                        $ref: '#/components/schemas/ResourceIcon'
                      - type: array
                        items: *id276
                required:
                - listresourceiconresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listresourceiconresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listresourceiconresponse
      x-cloudstack-command: listResourceIcon
      x-cloudstack-async: false
      x-cloudstack-since: 4.16.0.0
  /listResourceLimits:
    get:
      operationId: listResourceLimits
      summary: Lists resource limits.
      tags:
      - ResourceLimit
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listResourceLimits
          default: listResourceLimits
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: Lists resource limits by ID.
        schema:
          type: integer
          format: int64
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of resource. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of Instances a user can create. 1 - IP. Number of public IP addresses an account can own. 2 - Volume. Number of disk volumes an account can own. 3 - Snapshot. Number of Snapshots an account can own. 4 - Template. Number of Templates an account can register/create. 5 - Project. Number of projects an account can own. 6 - Network. Number of networks an account can own. 7 - VPC. Number of VPC an account can own. 8 - CPU. Number of CPU an account can allocate for their resources. 9 - Memory. Amount of RAM an account can allocate for their resources. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use.
        schema:
          type: integer
          format: int32
      - name: resourcetypename
        in: query
        description: 'Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of Instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of Snapshots an account can own. template - Template. Number of Templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use.'
        schema:
          type: string
          maxLength: 255
      - name: tag
        in: query
        description: Tag for the resource type
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      responses:
        '200':
          description: Successful invocation of `listResourceLimits`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listresourcelimitsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      resourcelimit:
                        type: array
                        items:
                          $ref: '#/components/schemas/ResourceLimit'
                    additionalProperties: true
                required:
                - listresourcelimitsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listresourcelimitsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listresourcelimitsresponse
      x-cloudstack-command: listResourceLimits
      x-cloudstack-async: false
  /listResourceSchedule:
    get:
      operationId: listResourceSchedule
      summary: List Resource Schedules
      tags:
      - ResourceSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listResourceSchedule
          default: listResourceSchedule
      - $ref: '#/components/parameters/response'
      - name: resourceid
        in: query
        description: ID of the resource for which schedules are to be listed.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of the resource.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: action
        in: query
        description: Action to take on the resource.
        schema:
          type: string
          maxLength: 255
      - name: enabled
        in: query
        description: Filter by enabled status.
        schema:
          type: boolean
      - name: id
        in: query
        description: ID of the schedule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listResourceSchedule
        - updateResourceSchedule
      - name: ids
        in: query
        description: comma separated list of schedule ids. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listResourceSchedule
        - updateResourceSchedule
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listResourceSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listresourcescheduleresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id277
                        $ref: '#/components/schemas/ResourceSchedule'
                      - type: array
                        items: *id277
                required:
                - listresourcescheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listresourcescheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listresourcescheduleresponse
      x-cloudstack-command: listResourceSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - updateResourceSchedule
  /listRolePermissions:
    get:
      operationId: listRolePermissions
      summary: Lists role permissions
      tags:
      - RolePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listRolePermissions
          default: listRolePermissions
      - $ref: '#/components/parameters/response'
      - name: roleid
        in: query
        description: ID of the role
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - importRole
        - listRoles
        - updateRole
      responses:
        '200':
          description: Successful invocation of `listRolePermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listrolepermissionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      rolepermission:
                        type: array
                        items:
                          $ref: '#/components/schemas/RolePermission'
                    additionalProperties: true
                required:
                - listrolepermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listrolepermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listrolepermissionsresponse
      x-cloudstack-command: listRolePermissions
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
  /listRoles:
    get:
      operationId: listRoles
      summary: Lists dynamic roles in CloudStack
      tags:
      - Role
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listRoles
          default: listRoles
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: List role by role ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listRoles
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List role by role name.
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: state
        in: query
        description: 'List role by role type status, valid options are: enabled, disabled'
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: 'List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listRoles`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listrolesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      role:
                        type: array
                        items:
                          $ref: '#/components/schemas/Role'
                    additionalProperties: true
                required:
                - listrolesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listrolesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listrolesresponse
      x-cloudstack-command: listRoles
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
  /listRouters:
    get:
      operationId: listRouters
      summary: List routers.
      tags:
      - Router
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listRouters
          default: listRouters
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: CPU arch of the router
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: clusterid
        in: query
        description: The cluster ID of the router
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fetchhealthcheckresults
        in: query
        description: If true is passed for this parameter, also fetch last executed health check results for the router. Default is false
        schema:
          type: boolean
        x-cloudstack-since: '4.14'
      - name: forvpc
        in: query
        description: If true is passed for this parameter, list only VPC routers
        schema:
          type: boolean
      - name: healthchecksfailed
        in: query
        description: If this parameter is passed, list only routers by health check results
        schema:
          type: boolean
        x-cloudstack-since: '4.16'
      - name: hostid
        in: query
        description: The host ID of the router
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      - name: id
        in: query
        description: The ID of the disk router
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the router
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: List by network id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The Pod ID of the router
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: state
        in: query
        description: The state of the router
        schema:
          type: string
          maxLength: 255
      - name: version
        in: query
        description: List virtual router elements by version
        schema:
          type: string
          maxLength: 255
      - name: vpcid
        in: query
        description: List networks by VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: zoneid
        in: query
        description: The Zone ID of the router
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listRouters`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listroutersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      router:
                        type: array
                        items:
                          $ref: '#/components/schemas/Router'
                    additionalProperties: true
                required:
                - listroutersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listroutersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listroutersresponse
      x-cloudstack-command: listRouters
      x-cloudstack-async: false
  /listRoutingFirewallRules:
    get:
      operationId: listRoutingFirewallRules
      summary: Lists all Routing firewall rules
      tags:
      - RoutingFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listRoutingFirewallRules
          default: listRoutingFirewallRules
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: fordisplay
        in: query
        description: list resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
      - name: id
        in: query
        description: Lists Routing firewall rule with the specified ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updatePortForwardingRule
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: networkid
        in: query
        description: list Routing firewall rules by network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: traffictype
        in: query
        description: list Routing firewall rules by traffic type - ingress or egress
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listRoutingFirewallRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listroutingfirewallrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      firewallrule:
                        type: array
                        items:
                          $ref: '#/components/schemas/Ipv6FirewallRule'
                    additionalProperties: true
                required:
                - listroutingfirewallrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listroutingfirewallrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listroutingfirewallrulesresponse
      x-cloudstack-command: listRoutingFirewallRules
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createIpForwardingRule
      - createPortForwardingRule
      - updatePortForwardingRule
  /listSSHKeyPairs:
    get:
      operationId: listSSHKeyPairs
      summary: List registered keypairs
      tags:
      - SSHKeyPair
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSSHKeyPairs
          default: listSSHKeyPairs
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fingerprint
        in: query
        description: A public key fingerprint to look for
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the SSH keypair
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listSSHKeyPairs
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: A key pair name to look for
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listSSHKeyPairs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsshkeypairsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      sshkeypair:
                        type: array
                        items:
                          $ref: '#/components/schemas/SSHKeyPair2'
                    additionalProperties: true
                required:
                - listsshkeypairsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsshkeypairsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsshkeypairsresponse
      x-cloudstack-command: listSSHKeyPairs
      x-cloudstack-async: false
  /listSecondaryStagingStores:
    get:
      operationId: listSecondaryStagingStores
      summary: Lists secondary staging stores.
      tags:
      - SecondaryStagingStore
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSecondaryStagingStores
          default: listSecondaryStagingStores
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the staging store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addImageStoreS3
        - addSecondaryStorage
        - addSwift
        - createSecondaryStagingStore
        - listImageStores
        - listSecondaryStagingStores
        - listSwifts
        - updateCloudToUseObjectStore
        - updateImageStore
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the staging store
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: protocol
        in: query
        description: The staging store protocol
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: The staging store provider
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID for the staging store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listSecondaryStagingStores`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsecondarystagingstoresresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id278
                        $ref: '#/components/schemas/ImageStore'
                      - type: array
                        items: *id278
                required:
                - listsecondarystagingstoresresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsecondarystagingstoresresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsecondarystagingstoresresponse
      x-cloudstack-command: listSecondaryStagingStores
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - addImageStore
      - addImageStoreS3
      - addSecondaryStorage
      - addSwift
      - createSecondaryStagingStore
      - listImageStores
      - listSwifts
      - updateCloudToUseObjectStore
      - updateImageStore
  /listSecondaryStorageSelectors:
    get:
      operationId: listSecondaryStorageSelectors
      summary: Lists the secondary storage selectors and their rules.
      tags:
      - SecondaryStorageSelector
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSecondaryStorageSelectors
          default: listSecondaryStorageSelectors
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The zone ID to be used in the search filter.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showremoved
        in: query
        description: Show removed heuristics.
        schema:
          type: boolean
      - name: type
        in: query
        description: 'Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, BACKUP, TEMPLATE and VOLUME.'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listSecondaryStorageSelectors`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsecondarystorageselectorsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id279
                        $ref: '#/components/schemas/SecondaryStorageSelector'
                      - type: array
                        items: *id279
                required:
                - listsecondarystorageselectorsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsecondarystorageselectorsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsecondarystorageselectorsresponse
      x-cloudstack-command: listSecondaryStorageSelectors
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /listSecurityGroups:
    get:
      operationId: listSecurityGroups
      summary: Lists security groups
      tags:
      - SecurityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSecurityGroups
          default: listSecurityGroups
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: id
        in: query
        description: List the security group by the id provided
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createSecurityGroup
        - listSecurityGroups
        - updateSecurityGroup
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: securitygroupname
        in: query
        description: Lists security groups by name
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: virtualmachineid
        in: query
        description: Lists security groups by Instance id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
        - updateVmNicIp
      responses:
        '200':
          description: Successful invocation of `listSecurityGroups`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsecuritygroupsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      securitygroup:
                        type: array
                        items:
                          $ref: '#/components/schemas/SecurityGroup'
                    additionalProperties: true
                required:
                - listsecuritygroupsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsecuritygroupsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsecuritygroupsresponse
      x-cloudstack-command: listSecurityGroups
      x-cloudstack-async: false
      x-cloudstack-related:
      - createSecurityGroup
      - updateSecurityGroup
  /listServiceOfferings:
    get:
      operationId: listServiceOfferings
      summary: Lists all available service offerings.
      tags:
      - ServiceOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listServiceOfferings
          default: listServiceOfferings
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: cpunumber
        in: query
        description: The CPU number that listed offerings must support
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.15'
      - name: cpuspeed
        in: query
        description: The CPU speed that listed offerings must support
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.15'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: encryptroot
        in: query
        description: Listed offerings support root disk encryption
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: gpuenabled
        in: query
        description: Flag to indicate if the service offering supports GPU. If set to true, only service offerings that support GPU will be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: id
        in: query
        description: ID of the service offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: issystem
        in: query
        description: Is this a System VM offering
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: memory
        in: query
        description: The RAM memory that listed offering must support
        schema:
          type: integer
          format: int32
        x-cloudstack-since: '4.15'
      - name: name
        in: query
        description: Name of the service offering
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: state
        in: query
        description: Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.19'
      - name: storagetype
        in: query
        description: the storage type of the service offering. Values are local and shared.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.19'
      - name: systemvmtype
        in: query
        description: The system Instance type. Possible types are "consoleproxy", "secondarystoragevm" or "domainrouter".
        schema:
          type: string
          maxLength: 255
      - name: templateid
        in: query
        description: The ID of the template that listed offerings must support
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.20.0
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: vgpuprofileid
        in: query
        description: The ID of the vGPU profile that listed offerings must support
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: virtualmachineid
        in: query
        description: The ID of the Instance. Pass this in if you want to see the available service offering that an Instance can be changed to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: zoneid
        in: query
        description: ID of zone disk offering is associated with
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listServiceOfferings`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listserviceofferingsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      serviceoffering:
                        type: array
                        items:
                          $ref: '#/components/schemas/ServiceOffering'
                    additionalProperties: true
                required:
                - listserviceofferingsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listserviceofferingsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listserviceofferingsresponse
      x-cloudstack-command: listServiceOfferings
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateServiceOffering
  /listSharedFileSystemProviders:
    get:
      operationId: listSharedFileSystemProviders
      summary: Lists all available shared filesystem providers.
      tags:
      - SharedFileSystemProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSharedFileSystemProviders
          default: listSharedFileSystemProviders
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listSharedFileSystemProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsharedfilesystemprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      sharedfilesystemprovider:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListDeploymentPlannersResult'
                    additionalProperties: true
                required:
                - listsharedfilesystemprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsharedfilesystemprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsharedfilesystemprovidersresponse
      x-cloudstack-command: listSharedFileSystemProviders
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /listSharedFileSystems:
    get:
      operationId: listSharedFileSystems
      summary: List Shared FileSystems
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSharedFileSystems
          default: listSharedFileSystems
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: diskofferingid
        in: query
        description: the disk offering of the shared filesystem
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: the ID of the shared filesystem
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
        - listSharedFileSystems
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: the name of the shared filesystem
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: the ID of the network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: retrieveonlyresourcecount
        in: query
        description: Makes the API's response contains only the resource count
        schema:
          type: boolean
      - name: serviceofferingid
        in: query
        description: the service offering of the shared filesystem
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: zoneid
        in: query
        description: the ID of the availability zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listSharedFileSystems`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsharedfilesystemsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id280
                        $ref: '#/components/schemas/SharedFileSystem'
                      - type: array
                        items: *id280
                required:
                - listsharedfilesystemsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsharedfilesystemsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsharedfilesystemsresponse
      x-cloudstack-command: listSharedFileSystems
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - changeSharedFileSystemDiskOffering
  /listSnapshotPolicies:
    get:
      operationId: listSnapshotPolicies
      summary: Lists Snapshot policies.
      tags:
      - SnapshotPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSnapshotPolicies
          default: listSnapshotPolicies
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: The ID of the Snapshot policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listSnapshotPolicies
        - updateSnapshotPolicy
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: volumeid
        in: query
        description: The ID of the disk volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      responses:
        '200':
          description: Successful invocation of `listSnapshotPolicies`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsnapshotpoliciesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id281
                        $ref: '#/components/schemas/SnapshotPolicy'
                      - type: array
                        items: *id281
                required:
                - listsnapshotpoliciesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsnapshotpoliciesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsnapshotpoliciesresponse
      x-cloudstack-command: listSnapshotPolicies
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateSnapshotPolicy
  /listSnapshots:
    get:
      operationId: listSnapshots
      summary: Lists all available snapshots for the account.
      tags:
      - Snapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSnapshots
          default: listSnapshots
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: Lists Snapshot by Snapshot ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - archiveSnapshot
        - copySnapshot
        - createSnapshotFromVMSnapshot
        - listSnapshots
      - name: ids
        in: query
        description: The IDs of the Snapshots, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.9'
        x-cloudstack-related:
        - archiveSnapshot
        - copySnapshot
        - createSnapshotFromVMSnapshot
        - listSnapshots
      - name: imagestoreid
        in: query
        description: ID of the image or image cache store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.19'
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - listSwifts
      - name: intervaltype
        in: query
        description: Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.
        schema:
          type: string
          maxLength: 255
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: locationtype
        in: query
        description: 'list snapshots by location type. Used only when showunique=false. Valid location types: ''primary'', ''secondary''. Default is empty'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: name
        in: query
        description: Lists Snapshot by Snapshot name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: showunique
        in: query
        description: If set to false, list templates across zones and their storages
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: snapshottype
        in: query
        description: Valid values are MANUAL or RECURRING.
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: ID of the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.19'
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: volumeid
        in: query
        description: The ID of the disk volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: zoneid
        in: query
        description: List Snapshots by zone id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listSnapshots`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsnapshotsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id282
                        $ref: '#/components/schemas/Snapshot'
                      - type: array
                        items: *id282
                required:
                - listsnapshotsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsnapshotsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsnapshotsresponse
      x-cloudstack-command: listSnapshots
      x-cloudstack-async: false
      x-cloudstack-related:
      - archiveSnapshot
      - copySnapshot
      - createSnapshotFromVMSnapshot
      - listSnapshots
  /listSslCerts:
    get:
      operationId: listSslCerts
      summary: Lists SSL certificates
      tags:
      - SslCert
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSslCerts
          default: listSslCerts
      - $ref: '#/components/parameters/response'
      - name: accountid
        in: query
        description: Account ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAccount
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      - name: certid
        in: query
        description: ID of SSL certificate
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listSslCerts
        - uploadSslCert
      - name: lbruleid
        in: query
        description: Load balancer rule ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: projectid
        in: query
        description: Project that owns the SSL certificate
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `listSslCerts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsslcertsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id283
                        $ref: '#/components/schemas/SslCert'
                      - type: array
                        items: *id283
                required:
                - listsslcertsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsslcertsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsslcertsresponse
      x-cloudstack-command: listSslCerts
      x-cloudstack-async: false
      x-cloudstack-related:
      - uploadSslCert
  /listStaticRoutes:
    get:
      operationId: listStaticRoutes
      summary: Lists all static routes
      tags:
      - StaticRoute
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listStaticRoutes
          default: listStaticRoutes
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: gatewayid
        in: query
        description: List static routes by gateway ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPrivateGateway
        - listPrivateGateways
      - name: id
        in: query
        description: List static route by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listStaticRoutes
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: state
        in: query
        description: List static routes by state
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: vpcid
        in: query
        description: List static routes by VPC ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `listStaticRoutes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststaticroutesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id284
                        $ref: '#/components/schemas/StaticRoute'
                      - type: array
                        items: *id284
                required:
                - liststaticroutesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststaticroutesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - liststaticroutesresponse
      x-cloudstack-command: listStaticRoutes
      x-cloudstack-async: false
  /listStorageAccessGroups:
    get:
      operationId: listStorageAccessGroups
      summary: Lists storage access groups
      tags:
      - StorageAccessGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listStorageAccessGroups
          default: listStorageAccessGroups
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the Storage access group
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listStorageAccessGroups`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststorageaccessgroupsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id285
                        $ref: '#/components/schemas/StorageAccessGroup'
                      - type: array
                        items: *id285
                required:
                - liststorageaccessgroupsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststorageaccessgroupsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - liststorageaccessgroupsresponse
      x-cloudstack-command: listStorageAccessGroups
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /listStorageNetworkIpRange:
    get:
      operationId: listStorageNetworkIpRange
      summary: List a storage network IP range.
      tags:
      - StorageNetworkIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listStorageNetworkIpRange
          default: listStorageNetworkIpRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Optional parameter. Storage network IP range UUID, if specified, using it to search the range.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createStorageNetworkIpRange
        - listStorageNetworkIpRange
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: Optional parameter. Pod UUID, if specified and range UUID is absent, using it to search the range.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: zoneid
        in: query
        description: Optional parameter. Zone UUID, if specified and both pod UUID and range UUID are absent, using it to search the range.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listStorageNetworkIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragenetworkiprangeresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id286
                        $ref: '#/components/schemas/StorageNetworkIpRange'
                      - type: array
                        items: *id286
                required:
                - liststoragenetworkiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragenetworkiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - liststoragenetworkiprangeresponse
      x-cloudstack-command: listStorageNetworkIpRange
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - createStorageNetworkIpRange
  /listStoragePoolObjects:
    get:
      operationId: listStoragePoolObjects
      summary: Lists objects at specified path on a storage pool.
      tags:
      - StoragePoolObject
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listStoragePoolObjects
          default: listStoragePoolObjects
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: id of the storage pool
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: path
        in: query
        description: path to list on storage pool
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listStoragePoolObjects`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragepoolobjectsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id287
                        $ref: '#/components/schemas/ListImageStoreObjectsResult'
                      - type: array
                        items: *id287
                required:
                - liststoragepoolobjectsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragepoolobjectsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - liststoragepoolobjectsresponse
      x-cloudstack-command: listStoragePoolObjects
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - listImageStoreObjects
  /listStoragePools:
    get:
      operationId: listStoragePools
      summary: Lists storage pools.
      tags:
      - StoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listStoragePools
          default: listStoragePools
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: List storage pools belonging to the specific cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: hostid
        in: query
        description: host ID of the storage pools
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      - name: id
        in: query
        description: The ID of the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: ipaddress
        in: query
        description: The IP address for the storage pool
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the storage pool
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: path
        in: query
        description: The storage pool path
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: The Pod ID for the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: scope
        in: query
        description: The scope of the storage pool
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: status
        in: query
        description: The status of the storage pool
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: storagecustomstats
        in: query
        description: If true, lists the custom stats of the storage pool
        schema:
          type: boolean
        x-cloudstack-since: 4.18.1
      - name: zoneid
        in: query
        description: The Zone ID for the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listStoragePools`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragepoolsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      storagepool:
                        type: array
                        items:
                          $ref: '#/components/schemas/StoragePool'
                    additionalProperties: true
                required:
                - liststoragepoolsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragepoolsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - liststoragepoolsresponse
      x-cloudstack-command: listStoragePools
      x-cloudstack-async: false
      x-cloudstack-related:
      - cancelStorageMaintenance
      - createStoragePool
      - enableStorageMaintenance
      - findStoragePoolsForMigration
      - syncStoragePool
      - updateStorageCapabilities
      - updateStoragePool
  /listStoragePoolsMetrics:
    get:
      operationId: listStoragePoolsMetrics
      summary: Lists storage pool metrics
      tags:
      - StoragePoolsMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listStoragePoolsMetrics
          default: listStoragePoolsMetrics
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: List storage pools belonging to the specific cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: hostid
        in: query
        description: host ID of the storage pools
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      - name: id
        in: query
        description: The ID of the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: ipaddress
        in: query
        description: The IP address for the storage pool
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the storage pool
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: path
        in: query
        description: The storage pool path
        schema:
          type: string
          maxLength: 255
      - name: podid
        in: query
        description: The Pod ID for the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: scope
        in: query
        description: The scope of the storage pool
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: status
        in: query
        description: The status of the storage pool
        schema:
          type: string
          maxLength: 255
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: storagecustomstats
        in: query
        description: If true, lists the custom stats of the storage pool
        schema:
          type: boolean
        x-cloudstack-since: 4.18.1
      - name: zoneid
        in: query
        description: The Zone ID for the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listStoragePoolsMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragepoolsmetricsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      storagepool:
                        type: array
                        items:
                          $ref: '#/components/schemas/StoragePoolsMetric'
                    additionalProperties: true
                required:
                - liststoragepoolsmetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragepoolsmetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - liststoragepoolsmetricsresponse
      x-cloudstack-command: listStoragePoolsMetrics
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.3
  /listStorageProviders:
    get:
      operationId: listStorageProviders
      summary: Lists storage providers.
      tags:
      - StorageProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listStorageProviders
          default: listStorageProviders
      - $ref: '#/components/parameters/response'
      - name: type
        in: query
        description: 'The type of storage provider: either primary or image'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listStorageProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststorageprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id288
                        $ref: '#/components/schemas/StorageProvider'
                      - type: array
                        items: *id288
                required:
                - liststorageprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststorageprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - liststorageprovidersresponse
      x-cloudstack-command: listStorageProviders
      x-cloudstack-async: false
  /listStorageTags:
    get:
      operationId: listStorageTags
      summary: Lists storage tags
      tags:
      - StorageTag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listStorageTags
          default: listStorageTags
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listStorageTags`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragetagsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id289
                        $ref: '#/components/schemas/StorageTag'
                      - type: array
                        items: *id289
                required:
                - liststoragetagsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  liststoragetagsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - liststoragetagsresponse
      x-cloudstack-command: listStorageTags
      x-cloudstack-async: false
  /listSupportedNetworkServices:
    get:
      operationId: listSupportedNetworkServices
      summary: Lists all network services provided by CloudStack or for the given Provider.
      tags:
      - SupportedNetworkService
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSupportedNetworkServices
          default: listSupportedNetworkServices
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: provider
        in: query
        description: Network service provider name
        schema:
          type: string
          maxLength: 255
      - name: service
        in: query
        description: Network service name to list providers and capabilities of
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listSupportedNetworkServices`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsupportednetworkservicesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      networkservice:
                        type: array
                        items:
                          $ref: '#/components/schemas/SupportedNetworkService'
                    additionalProperties: true
                required:
                - listsupportednetworkservicesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsupportednetworkservicesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsupportednetworkservicesresponse
      x-cloudstack-command: listSupportedNetworkServices
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
  /listSwifts:
    get:
      operationId: listSwifts
      summary: List Swift.
      tags:
      - Swift
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSwifts
          default: listSwifts
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The id of the swift
        schema:
          type: integer
          format: int64
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listSwifts`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listswiftsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id290
                        $ref: '#/components/schemas/ImageStore'
                      - type: array
                        items: *id290
                required:
                - listswiftsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listswiftsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listswiftsresponse
      x-cloudstack-command: listSwifts
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
  /listSystemVms:
    get:
      operationId: listSystemVms
      summary: List System VMs.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSystemVms
          default: listSystemVms
      - $ref: '#/components/parameters/response'
      - name: arch
        in: query
        description: CPU arch of the system VM
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: hostid
        in: query
        description: The host ID of the system VM
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      - name: id
        in: query
        description: The ID of the system VM
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForSystemVm
        - listSystemVms
        - migrateSystemVm
        - startSystemVm
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the system VM
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The Pod ID of the system VM
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: state
        in: query
        description: The state of the system VM
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: The storage ID where Instance's volumes belong to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 3.0.1
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: systemvmtype
        in: query
        description: The system VM type. Possible types are "consoleproxy" and "secondarystoragevm".
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID of the system VM
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listSystemVms`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsystemvmsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      systemvm:
                        type: array
                        items:
                          $ref: '#/components/schemas/SystemVm'
                    additionalProperties: true
                required:
                - listsystemvmsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsystemvmsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsystemvmsresponse
      x-cloudstack-command: listSystemVms
      x-cloudstack-async: false
      x-cloudstack-related:
      - changeServiceForSystemVm
      - migrateSystemVm
      - startSystemVm
  /listSystemVmsUsageHistory:
    get:
      operationId: listSystemVmsUsageHistory
      summary: Lists System VM stats
      tags:
      - SystemVmsUsageHistory
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listSystemVmsUsageHistory
          default: listSystemVmsUsageHistory
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: id
        in: query
        description: The ID of the system VM.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: ids
        in: query
        description: The IDs of the System VMs, mutually exclusive with ID. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: startdate
        in: query
        description: Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listSystemVmsUsageHistory`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsystemvmsusagehistoryresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      virtualmachine:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListSystemVmsUsageHistoryResult'
                    additionalProperties: true
                required:
                - listsystemvmsusagehistoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listsystemvmsusagehistoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listsystemvmsusagehistoryresponse
      x-cloudstack-command: listSystemVmsUsageHistory
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
  /listTags:
    get:
      operationId: listTags
      summary: List resource tag(s)
      tags:
      - Tag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTags
          default: listTags
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: customer
        in: query
        description: List by customer name
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: key
        in: query
        description: List by key
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: resourceid
        in: query
        description: List by resource ID
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: List by resource type
        schema:
          type: string
          maxLength: 255
      - name: value
        in: query
        description: List by value
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listTags`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtagsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id291
                        $ref: '#/components/schemas/ListResourceDetailsResult'
                      - type: array
                        items: *id291
                required:
                - listtagsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtagsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtagsresponse
      x-cloudstack-command: listTags
      x-cloudstack-async: false
      x-cloudstack-since: 4.0.0
      x-cloudstack-related:
      - listResourceDetails
  /listTemplateDirectDownloadCertificates:
    get:
      operationId: listTemplateDirectDownloadCertificates
      summary: List the uploaded certificates for direct download Templates
      tags:
      - TemplateDirectDownloadCertificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTemplateDirectDownloadCertificates
          default: listTemplateDirectDownloadCertificates
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: List direct download certificate by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listTemplateDirectDownloadCertificates
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listhosts
        in: query
        description: 'If set to true: include the hosts where the certificate is uploaded to'
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The zone where certificates are uploaded
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTemplateDirectDownloadCertificates`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtemplatedirectdownloadcertificatesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      directdownloadcertificate:
                        type: array
                        items:
                          $ref: '#/components/schemas/TemplateDirectDownloadCertificate'
                    additionalProperties: true
                required:
                - listtemplatedirectdownloadcertificatesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtemplatedirectdownloadcertificatesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtemplatedirectdownloadcertificatesresponse
      x-cloudstack-command: listTemplateDirectDownloadCertificates
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /listTemplatePermissions:
    get:
      operationId: listTemplatePermissions
      summary: List Template visibility and all accounts that have permissions to view this Template.
      tags:
      - TemplatePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTemplatePermissions
          default: listTemplatePermissions
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The Template ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listIsoPermissions
        - listTemplatePermissions
      responses:
        '200':
          description: Successful invocation of `listTemplatePermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtemplatepermissionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id292
                        $ref: '#/components/schemas/ListIsoPermissionsResult'
                      - type: array
                        items: *id292
                required:
                - listtemplatepermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtemplatepermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtemplatepermissionsresponse
      x-cloudstack-command: listTemplatePermissions
      x-cloudstack-async: false
      x-cloudstack-related:
      - listIsoPermissions
      - listTemplatePermissions
  /listTemplates:
    get:
      operationId: listTemplates
      summary: List all public, private, and privileged Templates.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTemplates
          default: listTemplates
      - $ref: '#/components/parameters/response'
      - name: templatefilter
        in: query
        description: 'Possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : Templates that have been marked as featured and public. * self : Templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. * sharedexecutable : Templates ready to be deployed that have been granted to the calling user by another user. * executable : Templates that are owned by the calling user, or public Templates, that can be used to deploy an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: details
        in: query
        description: Comma separated list of Template details requested, value can be a list of [all, min]. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.15'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: extensionid
        in: query
        description: ID of the extension for the template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - deleteExtension
        - listExtensions
        - unregisterExtension
        - updateExtension
      - name: forcks
        in: query
        description: list templates that can be used to deploy CKS clusters
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: hypervisor
        in: query
        description: The hypervisor for which to restrict the search
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The Template ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: ids
        in: query
        description: The IDs of the Templates, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.9'
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: imagestoreid
        in: query
        description: ID of the image or image cache store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.19'
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - listSwifts
      - name: isready
        in: query
        description: list templates that are ready to be deployed
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: isvnf
        in: query
        description: flag to list VNF templates or not; true if need to list VNF templates, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The Template name
        schema:
          type: string
          maxLength: 255
      - name: oscategoryid
        in: query
        description: the ID of the OS category for the template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listOsCategories
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: parenttemplateid
        in: query
        description: List datadisk Templates by parent Template id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: showicon
        in: query
        description: Flag to display the resource image for the Templates
        schema:
          type: boolean
      - name: showremoved
        in: query
        description: Show removed Templates as well
        schema:
          type: boolean
      - name: showunique
        in: query
        description: If set to true, list only unique Templates across zones
        schema:
          type: boolean
        x-cloudstack-since: 4.13.2
      - name: storageid
        in: query
        description: ID of the storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.19'
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: templatetype
        in: query
        description: the type of the template
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: zoneid
        in: query
        description: List Templates by zoneId
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTemplates`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtemplatesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id293
                        $ref: '#/components/schemas/Template'
                      - type: array
                        items: *id293
                required:
                - listtemplatesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtemplatesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtemplatesresponse
      x-cloudstack-command: listTemplates
      x-cloudstack-async: false
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - prepareTemplate
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateIso
      - updateTemplate
      - updateVnfTemplate
  /listTrafficMonitors:
    get:
      operationId: listTrafficMonitors
      summary: List traffic monitor Hosts.
      tags:
      - TrafficMonitor
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTrafficMonitors
          default: listTrafficMonitors
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: Zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listTrafficMonitors`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtrafficmonitorsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id294
                        $ref: '#/components/schemas/TrafficMonitor'
                      - type: array
                        items: *id294
                required:
                - listtrafficmonitorsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtrafficmonitorsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtrafficmonitorsresponse
      x-cloudstack-command: listTrafficMonitors
      x-cloudstack-async: false
      x-cloudstack-related:
      - addTrafficMonitor
  /listTrafficTypeImplementors:
    get:
      operationId: listTrafficTypeImplementors
      summary: Lists implementors of implementor of a network traffic type or implementors of all network traffic types
      tags:
      - TrafficTypeImplementor
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTrafficTypeImplementors
          default: listTrafficTypeImplementors
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: traffictype
        in: query
        description: Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listTrafficTypeImplementors`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtraffictypeimplementorsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      traffictypeimplementorresponse:
                        type: array
                        items:
                          $ref: '#/components/schemas/TrafficTypeImplementor'
                    additionalProperties: true
                required:
                - listtraffictypeimplementorsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtraffictypeimplementorsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtraffictypeimplementorsresponse
      x-cloudstack-command: listTrafficTypeImplementors
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
  /listTrafficTypes:
    get:
      operationId: listTrafficTypes
      summary: Lists traffic types of a given physical network.
      tags:
      - TrafficType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTrafficTypes
          default: listTrafficTypes
      - $ref: '#/components/parameters/response'
      - name: physicalnetworkid
        in: query
        description: The Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listTrafficTypes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtraffictypesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id295
                        $ref: '#/components/schemas/TrafficType'
                      - type: array
                        items: *id295
                required:
                - listtraffictypesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtraffictypesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtraffictypesresponse
      x-cloudstack-command: listTrafficTypes
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
  /listTungstenFabricAddressGroup:
    get:
      operationId: listTungstenFabricAddressGroup
      summary: List Tungsten-Fabric address group
      tags:
      - TungstenFabricAddressGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricAddressGroup
          default: listTungstenFabricAddressGroup
      - $ref: '#/components/parameters/response'
      - name: addressgroupuuid
        in: query
        description: The uuid of Tungsten-Fabric address group
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricAddressGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricaddressgroupresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id296
                        $ref: '#/components/schemas/TungstenFabricAddressGroup'
                      - type: array
                        items: *id296
                required:
                - listtungstenfabricaddressgroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricaddressgroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricaddressgroupresponse
      x-cloudstack-command: listTungstenFabricAddressGroup
      x-cloudstack-async: false
      x-cloudstack-related:
      - createTungstenFabricAddressGroup
  /listTungstenFabricApplicationPolicySet:
    get:
      operationId: listTungstenFabricApplicationPolicySet
      summary: List Tungsten-Fabric application policy set
      tags:
      - TungstenFabricApplicationPolicySet
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricApplicationPolicySet
          default: listTungstenFabricApplicationPolicySet
      - $ref: '#/components/parameters/response'
      - name: applicationpolicysetuuid
        in: query
        description: The uuid of Tungsten-Fabric application policy set
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricApplicationPolicySet`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricapplicationpolicysetresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id297
                        $ref: '#/components/schemas/TungstenFabricApplicationPolicySet'
                      - type: array
                        items: *id297
                required:
                - listtungstenfabricapplicationpolicysetresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricapplicationpolicysetresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricapplicationpolicysetresponse
      x-cloudstack-command: listTungstenFabricApplicationPolicySet
      x-cloudstack-async: false
      x-cloudstack-related:
      - createTungstenFabricApplicationPolicySet
  /listTungstenFabricFirewallPolicy:
    get:
      operationId: listTungstenFabricFirewallPolicy
      summary: List Tungsten-Fabric firewall policy
      tags:
      - TungstenFabricFirewallPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricFirewallPolicy
          default: listTungstenFabricFirewallPolicy
      - $ref: '#/components/parameters/response'
      - name: applicationpolicysetuuid
        in: query
        description: The UUID of Tungsten-Fabric application policy set
        schema:
          type: string
          maxLength: 255
      - name: firewallpolicyuuid
        in: query
        description: The UUID of Tungsten-Fabric firewall policy
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricFirewallPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricfirewallpolicyresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id298
                        $ref: '#/components/schemas/TungstenFabricFirewallPolicy'
                      - type: array
                        items: *id298
                required:
                - listtungstenfabricfirewallpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricfirewallpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricfirewallpolicyresponse
      x-cloudstack-command: listTungstenFabricFirewallPolicy
      x-cloudstack-async: false
      x-cloudstack-related:
      - createTungstenFabricFirewallPolicy
  /listTungstenFabricFirewallRule:
    get:
      operationId: listTungstenFabricFirewallRule
      summary: List Tungsten-Fabric firewall rule
      tags:
      - TungstenFabricFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricFirewallRule
          default: listTungstenFabricFirewallRule
      - $ref: '#/components/parameters/response'
      - name: firewallpolicyuuid
        in: query
        description: The uuid of Tungsten-Fabric firewall policy
        schema:
          type: string
          maxLength: 255
      - name: firewallruleuuid
        in: query
        description: The uuid of Tungsten-Fabric firewall rule
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricfirewallruleresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id299
                        $ref: '#/components/schemas/TungstenFabricFirewallRule'
                      - type: array
                        items: *id299
                required:
                - listtungstenfabricfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricfirewallruleresponse
      x-cloudstack-command: listTungstenFabricFirewallRule
      x-cloudstack-async: false
  /listTungstenFabricLBHealthMonitor:
    get:
      operationId: listTungstenFabricLBHealthMonitor
      summary: List Tungsten-Fabric LB health monitor
      tags:
      - TungstenFabricLBHealthMonitor
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricLBHealthMonitor
          default: listTungstenFabricLBHealthMonitor
      - $ref: '#/components/parameters/response'
      - name: lbruleid
        in: query
        description: The ID of lb rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listIpv6FirewallRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
        - updateRoutingFirewallRule
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricLBHealthMonitor`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabriclbhealthmonitorresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id300
                        $ref: '#/components/schemas/TungstenFabricLBHealthMonitor'
                      - type: array
                        items: *id300
                required:
                - listtungstenfabriclbhealthmonitorresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabriclbhealthmonitorresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabriclbhealthmonitorresponse
      x-cloudstack-command: listTungstenFabricLBHealthMonitor
      x-cloudstack-async: false
      x-cloudstack-related:
      - updateTungstenFabricLBHealthMonitor
  /listTungstenFabricLogicalRouter:
    get:
      operationId: listTungstenFabricLogicalRouter
      summary: List Tungsten-Fabric logical router
      tags:
      - TungstenFabricLogicalRouter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricLogicalRouter
          default: listTungstenFabricLogicalRouter
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: logicalrouteruuid
        in: query
        description: The uuid of Tungsten-Fabric logical router
        schema:
          type: string
          maxLength: 255
      - name: networkuuid
        in: query
        description: The uuid of Tungsten-Fabric network
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricLogicalRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabriclogicalrouterresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id301
                        $ref: '#/components/schemas/TungstenFabricPolicy'
                      - type: array
                        items: *id301
                required:
                - listtungstenfabriclogicalrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabriclogicalrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabriclogicalrouterresponse
      x-cloudstack-command: listTungstenFabricLogicalRouter
      x-cloudstack-async: false
      x-cloudstack-related:
      - createTungstenFabricLogicalRouter
      - removeTungstenFabricNetworkGatewayFromLogicalRouter
  /listTungstenFabricNetwork:
    get:
      operationId: listTungstenFabricNetwork
      summary: List Tungsten-Fabric network
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricNetwork
          default: listTungstenFabricNetwork
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that include public network. Default value is false
        schema:
          type: boolean
      - name: networkuuid
        in: query
        description: The uuid of Tungsten-Fabric network
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricnetworkresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id302
                        $ref: '#/components/schemas/TungstenFabricTagType'
                      - type: array
                        items: *id302
                required:
                - listtungstenfabricnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricnetworkresponse
      x-cloudstack-command: listTungstenFabricNetwork
      x-cloudstack-async: false
  /listTungstenFabricNic:
    get:
      operationId: listTungstenFabricNic
      summary: List Tungsten-Fabric nic
      tags:
      - TungstenFabricNic
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricNic
          default: listTungstenFabricNic
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: nicuuid
        in: query
        description: The uuid of Tungsten-Fabric nic
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricNic`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricnicresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id303
                        $ref: '#/components/schemas/TungstenFabricTagType'
                      - type: array
                        items: *id303
                required:
                - listtungstenfabricnicresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricnicresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricnicresponse
      x-cloudstack-command: listTungstenFabricNic
      x-cloudstack-async: false
  /listTungstenFabricPolicy:
    get:
      operationId: listTungstenFabricPolicy
      summary: List Tungsten-Fabric policy
      tags:
      - TungstenFabricPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricPolicy
          default: listTungstenFabricPolicy
      - $ref: '#/components/parameters/response'
      - name: ipaddressid
        in: query
        description: The ID of ip address
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - updateIpAddress
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: The ID of network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: policyuuid
        in: query
        description: The uuid of Tungsten-Fabric policy
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricpolicyresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id304
                        $ref: '#/components/schemas/TungstenFabricPolicy'
                      - type: array
                        items: *id304
                required:
                - listtungstenfabricpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricpolicyresponse
      x-cloudstack-command: listTungstenFabricPolicy
      x-cloudstack-async: false
  /listTungstenFabricPolicyRule:
    get:
      operationId: listTungstenFabricPolicyRule
      summary: List Tungsten-Fabric policy
      tags:
      - TungstenFabricPolicyRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricPolicyRule
          default: listTungstenFabricPolicyRule
      - $ref: '#/components/parameters/response'
      - name: policyuuid
        in: query
        description: The uuid of Tungsten-Fabric policy
        required: true
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: ruleuuid
        in: query
        description: The uuid of Tungsten-Fabric rule
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricPolicyRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricpolicyruleresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id305
                        $ref: '#/components/schemas/TungstenFabricPolicyRule'
                      - type: array
                        items: *id305
                required:
                - listtungstenfabricpolicyruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricpolicyruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricpolicyruleresponse
      x-cloudstack-command: listTungstenFabricPolicyRule
      x-cloudstack-async: false
      x-cloudstack-related:
      - addTungstenFabricPolicyRule
  /listTungstenFabricProviders:
    get:
      operationId: listTungstenFabricProviders
      summary: Lists Tungsten-Fabric providers
      tags:
      - TungstenFabricProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricProviders
          default: listTungstenFabricProviders
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id306
                        $ref: '#/components/schemas/TungstenFabricProvider'
                      - type: array
                        items: *id306
                required:
                - listtungstenfabricprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricprovidersresponse
      x-cloudstack-command: listTungstenFabricProviders
      x-cloudstack-async: false
      x-cloudstack-related:
      - createTungstenFabricProvider
  /listTungstenFabricServiceGroup:
    get:
      operationId: listTungstenFabricServiceGroup
      summary: List Tungsten-Fabric service group
      tags:
      - TungstenFabricServiceGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricServiceGroup
          default: listTungstenFabricServiceGroup
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: servicegroupuuid
        in: query
        description: The uuid of Tungsten-Fabric service group
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricServiceGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricservicegroupresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id307
                        $ref: '#/components/schemas/TungstenFabricServiceGroup'
                      - type: array
                        items: *id307
                required:
                - listtungstenfabricservicegroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricservicegroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricservicegroupresponse
      x-cloudstack-command: listTungstenFabricServiceGroup
      x-cloudstack-async: false
      x-cloudstack-related:
      - createTungstenFabricServiceGroup
  /listTungstenFabricTag:
    get:
      operationId: listTungstenFabricTag
      summary: Lists Tungsten-Fabric tags
      tags:
      - TungstenFabricTag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricTag
          default: listTungstenFabricTag
      - $ref: '#/components/parameters/response'
      - name: applicationpolicysetuuid
        in: query
        description: The uuid of Tungsten-Fabric application policy set
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: networkuuid
        in: query
        description: The uuid of Tungsten-Fabric Network
        schema:
          type: string
          maxLength: 255
      - name: nicuuid
        in: query
        description: The uuid of Tungsten-Fabric NIC
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: policyuuid
        in: query
        description: The uuid of Tungsten-Fabric policy
        schema:
          type: string
          maxLength: 255
      - name: taguuid
        in: query
        description: The uuid of Tungsten-Fabric tag
        schema:
          type: string
          maxLength: 255
      - name: vmuuid
        in: query
        description: The uuid of Tungsten-Fabric Instance
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricTag`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabrictagresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id308
                        $ref: '#/components/schemas/TungstenFabricTag'
                      - type: array
                        items: *id308
                required:
                - listtungstenfabrictagresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabrictagresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabrictagresponse
      x-cloudstack-command: listTungstenFabricTag
      x-cloudstack-async: false
      x-cloudstack-related:
      - applyTungstenFabricTag
  /listTungstenFabricTagType:
    get:
      operationId: listTungstenFabricTagType
      summary: Lists Tungsten-Fabric tags
      tags:
      - TungstenFabricTagType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricTagType
          default: listTungstenFabricTagType
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: tagtypeuuid
        in: query
        description: The uuid of Tungsten-Fabric tag type
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricTagType`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabrictagtyperesponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id309
                        $ref: '#/components/schemas/TungstenFabricTagType'
                      - type: array
                        items: *id309
                required:
                - listtungstenfabrictagtyperesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabrictagtyperesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabrictagtyperesponse
      x-cloudstack-command: listTungstenFabricTagType
      x-cloudstack-async: false
  /listTungstenFabricVm:
    get:
      operationId: listTungstenFabricVm
      summary: List Tungsten-Fabric vm
      tags:
      - TungstenFabricVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listTungstenFabricVm
          default: listTungstenFabricVm
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: vmuuid
        in: query
        description: The uuid of Tungsten-Fabric vm
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listTungstenFabricVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricvmresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id310
                        $ref: '#/components/schemas/TungstenFabricTagType'
                      - type: array
                        items: *id310
                required:
                - listtungstenfabricvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listtungstenfabricvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listtungstenfabricvmresponse
      x-cloudstack-command: listTungstenFabricVm
      x-cloudstack-async: false
  /listUcsBlades:
    get:
      operationId: listUcsBlades
      summary: List ucs blades
      tags:
      - UcsBlade
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUcsBlades
          default: listUcsBlades
      - $ref: '#/components/parameters/response'
      - name: ucsmanagerid
        in: query
        description: Ucs manager ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addUcsManager
        - listUcsManagers
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listUcsBlades`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listucsbladesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id311
                        $ref: '#/components/schemas/AssociateUcsProfileToBladeResult'
                      - type: array
                        items: *id311
                required:
                - listucsbladesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listucsbladesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listucsbladesresponse
      x-cloudstack-command: listUcsBlades
      x-cloudstack-async: false
      x-cloudstack-related:
      - associateUcsProfileToBlade
  /listUcsManagers:
    get:
      operationId: listUcsManagers
      summary: List ucs manager
      tags:
      - UcsManager
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUcsManagers
          default: listUcsManagers
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the ucs manager
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listUcsManagers
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: zoneid
        in: query
        description: The zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listUcsManagers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listucsmanagersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id312
                        $ref: '#/components/schemas/UcsManager'
                      - type: array
                        items: *id312
                required:
                - listucsmanagersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listucsmanagersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listucsmanagersresponse
      x-cloudstack-command: listUcsManagers
      x-cloudstack-async: false
  /listUcsProfiles:
    get:
      operationId: listUcsProfiles
      summary: List profile in ucs manager
      tags:
      - UcsProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUcsProfiles
          default: listUcsProfiles
      - $ref: '#/components/parameters/response'
      - name: ucsmanagerid
        in: query
        description: The ID for the ucs manager
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listUcsProfiles`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listucsprofilesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id313
                        $ref: '#/components/schemas/UcsProfile'
                      - type: array
                        items: *id313
                required:
                - listucsprofilesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listucsprofilesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listucsprofilesresponse
      x-cloudstack-command: listUcsProfiles
      x-cloudstack-async: false
  /listUnmanagedInstances:
    get:
      operationId: listUnmanagedInstances
      summary: Lists unmanaged Instances for a given cluster.
      tags:
      - UnmanagedInstance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUnmanagedInstances
          default: listUnmanagedInstances
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: The cluster ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The hypervisor name of the Instance
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listUnmanagedInstances`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listunmanagedinstancesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id314
                        $ref: '#/components/schemas/ListUnmanagedInstancesResult'
                      - type: array
                        items: *id314
                required:
                - listunmanagedinstancesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listunmanagedinstancesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listunmanagedinstancesresponse
      x-cloudstack-command: listUnmanagedInstances
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
  /listUsageRecords:
    get:
      operationId: listUsageRecords
      summary: Lists usage records for accounts
      tags:
      - UsageRecord
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUsageRecords
          default: listUsageRecords
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: 'End date range for usage record query. The recommended format is "yyyy-MM-dd''T''HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".'
        required: true
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: startdate
        in: query
        description: 'Start date range for usage record query. The recommended format is "yyyy-MM-dd''T''HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".'
        required: true
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: account
        in: query
        description: List usage records for the specified user.
        schema:
          type: string
          maxLength: 255
      - name: accountid
        in: query
        description: List usage records for the specified account
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - enableAccount
        - listAccounts
      - name: domainid
        in: query
        description: List usage records for the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: includetags
        in: query
        description: Flag to enable display of Tags for a resource
        schema:
          type: boolean
      - name: isrecursive
        in: query
        description: Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.
        schema:
          type: boolean
        x-cloudstack-since: '4.15'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: oldformat
        in: query
        description: Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List usage records for specified project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: type
        in: query
        description: List usage records for the specified usage type
        schema:
          type: integer
          format: int64
      - name: usageid
        in: query
        description: List usage records for the specified usage UUID. Can be used only together with TYPE parameter.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listUsageRecords`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusagerecordsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id315
                        $ref: '#/components/schemas/UsageRecord'
                      - type: array
                        items: *id315
                required:
                - listusagerecordsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusagerecordsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listusagerecordsresponse
      x-cloudstack-command: listUsageRecords
      x-cloudstack-async: false
  /listUsageServerMetrics:
    get:
      operationId: listUsageServerMetrics
      summary: Lists Usage Server metrics
      tags:
      - UsageServerMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUsageServerMetrics
          default: listUsageServerMetrics
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `listUsageServerMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusageservermetricsresponse:
                    type: object
                    properties:
                      usageMetrics:
                        $ref: '#/components/schemas/UsageServerMetric'
                    additionalProperties: true
                required:
                - listusageservermetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusageservermetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listusageservermetricsresponse
      x-cloudstack-command: listUsageServerMetrics
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /listUsageTypes:
    get:
      operationId: listUsageTypes
      summary: List Usage Types
      tags:
      - UsageType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUsageTypes
          default: listUsageTypes
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `listUsageTypes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusagetypesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      usagetype:
                        type: array
                        items:
                          $ref: '#/components/schemas/UsageType'
                    additionalProperties: true
                required:
                - listusagetypesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusagetypesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listusagetypesresponse
      x-cloudstack-command: listUsageTypes
      x-cloudstack-async: false
  /listUserData:
    get:
      operationId: listUserData
      summary: List registered userdatas
      tags:
      - UserData
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUserData
          default: listUserData
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: id
        in: query
        description: The ID of the Userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listCniConfiguration
        - listUserData
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Userdata name to look for
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `listUserData`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listuserdataresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id316
                        $ref: '#/components/schemas/ListCniConfigurationResult'
                      - type: array
                        items: *id316
                required:
                - listuserdataresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listuserdataresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listuserdataresponse
      x-cloudstack-command: listUserData
      x-cloudstack-async: false
      x-cloudstack-since: '4.18'
      x-cloudstack-related:
      - listCniConfiguration
  /listUserKeyRules:
    get:
      operationId: listUserKeyRules
      summary: Lists the rules defined for a API key pair.
      tags:
      - UserKeyRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUserKeyRules
          default: listUserKeyRules
      - $ref: '#/components/parameters/response'
      - name: keypairid
        in: query
        description: ID of the key pair.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listUserKeys
      responses:
        '200':
          description: Successful invocation of `listUserKeyRules`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listuserkeyrulesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id317
                        $ref: '#/components/schemas/UserKeyRule'
                      - type: array
                        items: *id317
                required:
                - listuserkeyrulesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listuserkeyrulesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listuserkeyrulesresponse
      x-cloudstack-command: listUserKeyRules
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /listUserKeys:
    get:
      operationId: listUserKeys
      summary: Lists the API key pairs (API and secret keys) of a user.
      tags:
      - UserKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUserKeys
          default: listUserKeys
      - $ref: '#/components/parameters/response'
      - name: apikeyfilter
        in: query
        description: API key of the key pair.
        schema:
          type: string
          maxLength: 255
      - name: keypairid
        in: query
        description: ID of the key pair.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listUserKeys
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: Lists all API key pairs of users that are accessible by the calling account. Only available for administrators. Defaults to false.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showpermissions
        in: query
        description: Whether API Key rules should be returned. Defaults to false.
        schema:
          type: boolean
      - name: userid
        in: query
        description: ID of the user that owns the keys.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - getUser
      responses:
        '200':
          description: Successful invocation of `listUserKeys`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listuserkeysresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      userapikey:
                        type: array
                        items:
                          $ref: '#/components/schemas/UserKey2'
                    additionalProperties: true
                required:
                - listuserkeysresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listuserkeysresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listuserkeysresponse
      x-cloudstack-command: listUserKeys
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /listUserTwoFactorAuthenticatorProviders:
    get:
      operationId: listUserTwoFactorAuthenticatorProviders
      summary: Lists user two factor authenticator providers
      tags:
      - UserTwoFactorAuthenticatorProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUserTwoFactorAuthenticatorProviders
          default: listUserTwoFactorAuthenticatorProviders
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: List user two factor authenticator provider by name
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listUserTwoFactorAuthenticatorProviders`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusertwofactorauthenticatorprovidersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      providers:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListBackupProvidersResult'
                    additionalProperties: true
                required:
                - listusertwofactorauthenticatorprovidersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusertwofactorauthenticatorprovidersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listusertwofactorauthenticatorprovidersresponse
      x-cloudstack-command: listUserTwoFactorAuthenticatorProviders
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
  /listUsers:
    get:
      operationId: listUsers
      summary: Lists user accounts
      tags:
      - User
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listUsers
          default: listUsers
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: accounttype
        in: query
        description: List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.
        schema:
          type: integer
          format: int32
      - name: apikeyaccess
        in: query
        description: List users by the Api key access value
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1.0
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: List user by ID.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showicon
        in: query
        description: Flag to display the resource icon for users
        schema:
          type: boolean
      - name: state
        in: query
        description: List users by state of the user account.
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: List user by the username
        schema:
          type: string
          maxLength: 255
      - name: usersource
        in: query
        description: 'List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0.0
      responses:
        '200':
          description: Successful invocation of `listUsers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      user:
                        type: array
                        items:
                          $ref: '#/components/schemas/User2'
                    additionalProperties: true
                required:
                - listusersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listusersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listusersresponse
      x-cloudstack-command: listUsers
      x-cloudstack-async: false
      x-cloudstack-related:
      - disableUser
      - getUser
  /listVMSchedule:
    get:
      operationId: listVMSchedule
      summary: List Instance Schedules.
      tags:
      - VMSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVMSchedule
          default: listVMSchedule
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: ID of the Instance for which schedule is to be defined
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
        - updateVmNicIp
      - name: action
        in: query
        description: Action taken by schedule
        schema:
          type: string
          maxLength: 255
      - name: enabled
        in: query
        description: Filter by enabled status
        schema:
          type: boolean
      - name: id
        in: query
        description: ID of Instance schedule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVMSchedule
        - listVMSchedule
        - updateVMSchedule
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listVMSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmscheduleresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id318
                        $ref: '#/components/schemas/VMSchedule'
                      - type: array
                        items: *id318
                required:
                - listvmscheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmscheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvmscheduleresponse
      x-cloudstack-command: listVMSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - createVMSchedule
      - updateVMSchedule
  /listVMSnapshot:
    get:
      operationId: listVMSnapshot
      summary: List Instance Snapshot by conditions
      tags:
      - VMSnapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVMSnapshot
          default: listVMSnapshot
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Lists Snapshot by Snapshot name or display name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: state
        in: query
        description: State of the Instance Snapshot
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: vmsnapshotid
        in: query
        description: The ID of the Instance Snapshot
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVMSnapshot
        - listVMSnapshot
      - name: vmsnapshotids
        in: query
        description: The IDs of the Instance Snapshots, mutually exclusive with vmsnapshotid. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.9'
        x-cloudstack-related:
        - createVMSnapshot
        - listVMSnapshot
      responses:
        '200':
          description: Successful invocation of `listVMSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmsnapshotresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id319
                        $ref: '#/components/schemas/VMSnapshot'
                      - type: array
                        items: *id319
                required:
                - listvmsnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmsnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvmsnapshotresponse
      x-cloudstack-command: listVMSnapshot
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - createVMSnapshot
  /listVPCOfferings:
    get:
      operationId: listVPCOfferings
      summary: Lists VPC offerings
      tags:
      - VPCOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVPCOfferings
          default: listVPCOfferings
      - $ref: '#/components/parameters/response'
      - name: displaytext
        in: query
        description: List VPC offerings by display text
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List VPC offerings available for VPC creation in specific domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.18'
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: id
        in: query
        description: List VPC offerings by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneVPCOffering
        - listVPCOfferings
        - updateVPCOffering
      - name: isdefault
        in: query
        description: True if need to list only default VPC offerings. Default value is false
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: List VPC offerings by name
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: state
        in: query
        description: List VPC offerings by state
        schema:
          type: string
          maxLength: 255
      - name: supportedservices
        in: query
        description: List VPC offerings supporting certain services. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: zoneid
        in: query
        description: ID of zone VPC offering is associated with
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.13'
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listVPCOfferings`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpcofferingsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      vpcoffering:
                        type: array
                        items:
                          $ref: '#/components/schemas/VPCOffering'
                    additionalProperties: true
                required:
                - listvpcofferingsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpcofferingsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvpcofferingsresponse
      x-cloudstack-command: listVPCOfferings
      x-cloudstack-async: false
      x-cloudstack-related:
      - cloneVPCOffering
      - updateVPCOffering
  /listVPCs:
    get:
      operationId: listVPCs
      summary: Lists VPCs
      tags:
      - VPC
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVPCs
          default: listVPCs
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: cidr
        in: query
        description: List by CIDR of the VPC. All VPC Guest Network's CIDRs should be within this CIDR
        schema:
          type: string
          maxLength: 255
      - name: displaytext
        in: query
        description: List by display text of The VPC
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: List VPC by ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: List by name of the VPC
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: restartrequired
        in: query
        description: List VPCs by restartRequired option
        schema:
          type: boolean
      - name: showicon
        in: query
        description: Flag to display the resource icon for VPCs
        schema:
          type: boolean
      - name: state
        in: query
        description: List VPCs by state
        schema:
          type: string
          maxLength: 255
      - name: supportedservices
        in: query
        description: List VPC supporting certain services. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: vpcofferingid
        in: query
        description: List by ID of the VPC offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVPCOffering
      - name: zoneid
        in: query
        description: List by zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listVPCs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpcsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      vpc:
                        type: array
                        items:
                          $ref: '#/components/schemas/VPC'
                    additionalProperties: true
                required:
                - listvpcsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpcsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvpcsresponse
      x-cloudstack-command: listVPCs
      x-cloudstack-async: false
      x-cloudstack-related:
      - createVPC
      - listVPCs
      - updateVPC
  /listVgpuProfiles:
    get:
      operationId: listVgpuProfiles
      summary: Lists all available vGPU profiles
      tags:
      - VgpuProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVgpuProfiles
          default: listVgpuProfiles
      - $ref: '#/components/parameters/response'
      - name: activeonly
        in: query
        description: If true, only vGPU profiles which have a device will be listed. If false, all vGPU profiles will be listed.
        schema:
          type: boolean
      - name: gpucardid
        in: query
        description: the GPU card ID associated with this GPU device
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGpuCards
        - updateGpuCard
      - name: id
        in: query
        description: ID of the vGPU profile
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVgpuProfile
        - listVgpuProfiles
        - updateVgpuProfile
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: name of the vGPU profile
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listVgpuProfiles`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvgpuprofilesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id320
                        $ref: '#/components/schemas/VgpuProfile'
                      - type: array
                        items: *id320
                required:
                - listvgpuprofilesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvgpuprofilesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvgpuprofilesresponse
      x-cloudstack-command: listVgpuProfiles
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - createVgpuProfile
      - updateVgpuProfile
  /listVirtualMachines:
    get:
      operationId: listVirtualMachines
      summary: List the Instances owned by the account.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVirtualMachines
          default: listVirtualMachines
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: accumulate
        in: query
        description: Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.
        schema:
          type: boolean
        x-cloudstack-since: 4.17.0
      - name: affinitygroupid
        in: query
        description: List Instances by affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAffinityGroup
        - listAffinityGroups
      - name: arch
        in: query
        description: CPU arch of the VM
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: autoscalevmgroupid
        in: query
        description: The ID of AutoScaling Instance Group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.18.0
        x-cloudstack-related:
        - enableAutoScaleVmGroup
        - listAutoScaleVmGroups
      - name: backupofferingid
        in: query
        description: List by the backup offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
        x-cloudstack-related:
        - cloneBackupOffering
        - createBackupOffering
        - importBackupOffering
        - listBackupOfferings
        - listBackupProviderOfferings
        - updateBackupOffering
      - name: clusterid
        in: query
        description: The cluster ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.16.0
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: details
        in: query
        description: Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: displayvm
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: extensionid
        in: query
        description: The ID of the Orchestrator extension for the VM
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - createExtension
        - deleteExtension
        - listExtensions
        - registerExtension
        - unregisterExtension
        - updateExtension
      - name: forvirtualnetwork
        in: query
        description: List by Network type; true if need to list Instances using Virtual Network, false otherwise
        schema:
          type: boolean
      - name: gpuenabled
        in: query
        description: Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: groupid
        in: query
        description: The group ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createInstanceGroup
        - updateInstanceGroup
      - name: haenable
        in: query
        description: List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled
        schema:
          type: boolean
        x-cloudstack-since: '4.15'
      - name: hostid
        in: query
        description: The host ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: hypervisor
        in: query
        description: The target hypervisor for the Template
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: ids
        in: query
        description: The IDs of the Instances, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: isoid
        in: query
        description: List Instances by ISO
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: isvnf
        in: query
        description: flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: keypair
        in: query
        description: List Instances by SSH keypair name
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: leased
        in: query
        description: Whether to return only leased instances
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: List by Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The pod ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: retrieveonlyresourcecount
        in: query
        description: Makes the API's response contains only the resource count
        schema:
          type: boolean
      - name: securitygroupid
        in: query
        description: The security group ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.15'
        x-cloudstack-related:
        - createSecurityGroup
        - updateSecurityGroup
      - name: serviceofferingid
        in: query
        description: List by the service offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: showicon
        in: query
        description: Flag to display the resource icon for Instances
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0.0
      - name: state
        in: query
        description: 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.'
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: The storage ID where Instance's volumes belong to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: templateid
        in: query
        description: List Instances by Template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: userdata
        in: query
        description: Whether to return the Instances' User data or not. By default, User data will not be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.18.0.0
      - name: userdataid
        in: query
        description: the instances by userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.20.1
        x-cloudstack-related:
        - listCniConfiguration
      - name: userid
        in: query
        description: The user ID that created the Instance and is under the Account that owns the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
        - updateUser
      - name: vpcid
        in: query
        description: List Instances by VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      - name: zoneid
        in: query
        description: The availability zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listVirtualMachines`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvirtualmachinesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      virtualmachine:
                        type: array
                        items:
                          $ref: '#/components/schemas/VirtualMachine'
                    additionalProperties: true
                required:
                - listvirtualmachinesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvirtualmachinesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvirtualmachinesresponse
      x-cloudstack-command: listVirtualMachines
      x-cloudstack-async: false
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
  /listVirtualMachinesMetrics:
    get:
      operationId: listVirtualMachinesMetrics
      summary: Lists VM metrics
      tags:
      - VirtualMachinesMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVirtualMachinesMetrics
          default: listVirtualMachinesMetrics
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: accumulate
        in: query
        description: Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.
        schema:
          type: boolean
        x-cloudstack-since: 4.17.0
      - name: affinitygroupid
        in: query
        description: List Instances by affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAffinityGroup
        - listAffinityGroups
      - name: arch
        in: query
        description: CPU arch of the VM
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: autoscalevmgroupid
        in: query
        description: The ID of AutoScaling Instance Group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.18.0
        x-cloudstack-related:
        - enableAutoScaleVmGroup
      - name: backupofferingid
        in: query
        description: List by the backup offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
        x-cloudstack-related:
        - createBackupOffering
        - listBackupOfferings
        - updateBackupOffering
      - name: clusterid
        in: query
        description: The cluster ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: details
        in: query
        description: Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: displayvm
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: extensionid
        in: query
        description: The ID of the Orchestrator extension for the VM
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - deleteExtension
        - listExtensions
        - registerExtension
        - unregisterExtension
        - updateExtension
      - name: forvirtualnetwork
        in: query
        description: List by Network type; true if need to list Instances using Virtual Network, false otherwise
        schema:
          type: boolean
      - name: gpuenabled
        in: query
        description: Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: groupid
        in: query
        description: The group ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateInstanceGroup
      - name: haenable
        in: query
        description: List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled
        schema:
          type: boolean
        x-cloudstack-since: '4.15'
      - name: hostid
        in: query
        description: The host ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: hypervisor
        in: query
        description: The target hypervisor for the Template
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: ids
        in: query
        description: The IDs of the Instances, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: isoid
        in: query
        description: List Instances by ISO
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: isvnf
        in: query
        description: flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: keypair
        in: query
        description: List Instances by SSH keypair name
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: leased
        in: query
        description: Whether to return only leased instances
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: List by Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The pod ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - listPods
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: retrieveonlyresourcecount
        in: query
        description: Makes the API's response contains only the resource count
        schema:
          type: boolean
      - name: securitygroupid
        in: query
        description: The security group ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.15'
        x-cloudstack-related:
        - updateSecurityGroup
      - name: serviceofferingid
        in: query
        description: List by the service offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: showicon
        in: query
        description: Flag to display the resource icon for Instances
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0.0
      - name: state
        in: query
        description: 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.'
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: The storage ID where vm's volumes belong to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: templateid
        in: query
        description: List Instances by Template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: userdata
        in: query
        description: Whether to return the Instances' User data or not. By default, User data will not be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.18.0.0
      - name: userdataid
        in: query
        description: the instances by userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.20.1
        x-cloudstack-related:
        - listCniConfiguration
      - name: userid
        in: query
        description: The user ID that created the Instance and is under the Account that owns the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
        - lockUser
      - name: vpcid
        in: query
        description: List Instances by VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: zoneid
        in: query
        description: The availability zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listVirtualMachinesMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvirtualmachinesmetricsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      virtualmachine:
                        type: array
                        items:
                          $ref: '#/components/schemas/VirtualMachinesMetric'
                    additionalProperties: true
                required:
                - listvirtualmachinesmetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvirtualmachinesmetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvirtualmachinesmetricsresponse
      x-cloudstack-command: listVirtualMachinesMetrics
      x-cloudstack-async: false
      x-cloudstack-related:
      - listVirtualMachinesMetrics
  /listVirtualMachinesUsageHistory:
    get:
      operationId: listVirtualMachinesUsageHistory
      summary: Lists VM stats
      tags:
      - VirtualMachinesUsageHistory
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVirtualMachinesUsageHistory
          default: listVirtualMachinesUsageHistory
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: id
        in: query
        description: The ID of the Instance.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: ids
        in: query
        description: The IDs of the Instances, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the Instance (a substring match is made against the parameter value returning the data for all matching Instances).
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: startdate
        in: query
        description: Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listVirtualMachinesUsageHistory`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvirtualmachinesusagehistoryresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      virtualmachine:
                        type: array
                        items:
                          $ref: '#/components/schemas/ListSystemVmsUsageHistoryResult'
                    additionalProperties: true
                required:
                - listvirtualmachinesusagehistoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvirtualmachinesusagehistoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvirtualmachinesusagehistoryresponse
      x-cloudstack-command: listVirtualMachinesUsageHistory
      x-cloudstack-async: false
      x-cloudstack-since: '4.17'
      x-cloudstack-related:
      - listSystemVmsUsageHistory
  /listVirtualRouterElements:
    get:
      operationId: listVirtualRouterElements
      summary: Lists all available virtual router elements.
      tags:
      - VirtualRouterElement
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVirtualRouterElements
          default: listVirtualRouterElements
      - $ref: '#/components/parameters/response'
      - name: enabled
        in: query
        description: List network offerings by enabled state
        schema:
          type: boolean
      - name: id
        in: query
        description: List virtual router elements by id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - configureVirtualRouterElement
        - listVirtualRouterElements
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: nspid
        in: query
        description: List virtual router elements by network service provider id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetworkServiceProvider
        - listNetworkServiceProviders
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listVirtualRouterElements`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvirtualrouterelementsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      virtualrouterelement:
                        type: array
                        items:
                          $ref: '#/components/schemas/VirtualRouterElement'
                    additionalProperties: true
                required:
                - listvirtualrouterelementsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvirtualrouterelementsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvirtualrouterelementsresponse
      x-cloudstack-command: listVirtualRouterElements
      x-cloudstack-async: false
      x-cloudstack-related:
      - configureVirtualRouterElement
  /listVlanIpRanges:
    get:
      operationId: listVlanIpRanges
      summary: Lists all VLAN IP ranges.
      tags:
      - VlanIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVlanIpRanges
          default: listVlanIpRanges
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The account with which the VLAN IP range is associated. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID with which the VLAN IP range is associated.  If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: forvirtualnetwork
        in: query
        description: True if VLAN is of Virtual type, false if Direct
        schema:
          type: boolean
      - name: id
        in: query
        description: The ID of the VLAN IP range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVlanIpRange
        - dedicatePublicIpRange
        - listVlanIpRanges
        - updateVlanIpRange
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: Network ID of the VLAN IP range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: physicalnetworkid
        in: query
        description: Physical Network ID of the VLAN IP range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPhysicalNetwork
        - listPhysicalNetworks
        - updatePhysicalNetwork
      - name: podid
        in: query
        description: The Pod ID of the VLAN IP range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: projectid
        in: query
        description: Project who will own the VLAN
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - suspendProject
        - updateProject
      - name: vlan
        in: query
        description: The ID or VID of the VLAN. Default is an "untagged" VLAN.
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The Zone ID of the VLAN IP range
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listVlanIpRanges`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvlaniprangesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      vlaniprange:
                        type: array
                        items:
                          $ref: '#/components/schemas/VlanIpRange'
                    additionalProperties: true
                required:
                - listvlaniprangesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvlaniprangesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvlaniprangesresponse
      x-cloudstack-command: listVlanIpRanges
      x-cloudstack-async: false
      x-cloudstack-related:
      - createVlanIpRange
      - dedicatePublicIpRange
      - updateVlanIpRange
  /listVmsForImport:
    get:
      operationId: listVmsForImport
      summary: Lists virtual machines on a unmanaged host
      tags:
      - VmsForImport
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVmsForImport
          default: listVmsForImport
      - $ref: '#/components/parameters/response'
      - name: host
        in: query
        description: the host name or IP address
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hypervisor
        in: query
        description: hypervisor type of the host
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: the zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: password
        in: query
        description: the password for the host
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: the username for the host
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listVmsForImport`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmsforimportresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id321
                        $ref: '#/components/schemas/ListUnmanagedInstancesResult'
                      - type: array
                        items: *id321
                required:
                - listvmsforimportresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmsforimportresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvmsforimportresponse
      x-cloudstack-command: listVmsForImport
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - listUnmanagedInstances
      - listVmwareDcVms
  /listVmwareDcVms:
    get:
      operationId: listVmwareDcVms
      summary: Lists the VMs in a VMware Datacenter
      tags:
      - VmwareDcVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVmwareDcVms
          default: listVmwareDcVms
      - $ref: '#/components/parameters/response'
      - name: datacentername
        in: query
        description: Name of VMware datacenter.
        schema:
          type: string
          maxLength: 255
      - name: existingvcenterid
        in: query
        description: UUID of a linked existing vCenter
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: hostname
        in: query
        description: Name of the host on vCenter. Must be set along with the instancename parameter
        schema:
          type: string
          maxLength: 255
      - name: instancename
        in: query
        description: Name of the VM on vCenter. Must be set along with the hostname parameter
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: password
        in: query
        description: The password for specified username.
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: The Username required to connect to resource.
        schema:
          type: string
          maxLength: 255
      - name: vcenter
        in: query
        description: The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listVmwareDcVms`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmwaredcvmsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id322
                        $ref: '#/components/schemas/ListUnmanagedInstancesResult'
                      - type: array
                        items: *id322
                required:
                - listvmwaredcvmsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmwaredcvmsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvmwaredcvmsresponse
      x-cloudstack-command: listVmwareDcVms
      x-cloudstack-async: false
      x-cloudstack-related:
      - listUnmanagedInstances
  /listVmwareDcs:
    get:
      operationId: listVmwareDcs
      summary: Retrieves VMware DC(s) associated with a zone.
      tags:
      - VmwareDc
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVmwareDcs
          default: listVmwareDcs
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: Id of the CloudStack zone.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `listVmwareDcs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmwaredcsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id323
                        $ref: '#/components/schemas/VmwareDc'
                      - type: array
                        items: *id323
                required:
                - listvmwaredcsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvmwaredcsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvmwaredcsresponse
      x-cloudstack-command: listVmwareDcs
      x-cloudstack-async: false
      x-cloudstack-related:
      - addVmwareDc
  /listVnfAppliances:
    get:
      operationId: listVnfAppliances
      summary: List VNF appliance owned by the account.
      tags:
      - VnfAppliance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVnfAppliances
          default: listVnfAppliances
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: accumulate
        in: query
        description: Accumulates the Instance metrics data instead of returning only the most recent data collected. The default behavior is set by the global configuration vm.stats.increment.metrics.
        schema:
          type: boolean
        x-cloudstack-since: 4.17.0
      - name: affinitygroupid
        in: query
        description: List Instances by affinity group
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: arch
        in: query
        description: CPU arch of the VM
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: autoscalevmgroupid
        in: query
        description: The ID of AutoScaling Instance Group
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: backupofferingid
        in: query
        description: List by the backup offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.17'
      - name: details
        in: query
        description: Comma separated list of Instance details requested, value can be a list of [all, group, nics, stats, secgrp, tmpl, servoff, diskoff, backoff, iso, volume, min, affgrp]. When no parameters are passed, all the details are returned if list.vm.default.details.stats is true (default), otherwise when list.vm.default.details.stats is false the API response will exclude the stats details. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: displayvm
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: extensionid
        in: query
        description: The ID of the Orchestrator extension for the VM
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listExtensions
      - name: forvirtualnetwork
        in: query
        description: List by Network type; true if need to list Instances using Virtual Network, false otherwise
        schema:
          type: boolean
      - name: gpuenabled
        in: query
        description: Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: groupid
        in: query
        description: The group ID
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: haenable
        in: query
        description: List by the High Availability offering; true if filtering Instances with HA enabled; false for Instances with HA disabled
        schema:
          type: boolean
        x-cloudstack-since: '4.15'
      - name: hypervisor
        in: query
        description: The target hypervisor for the Template
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: ids
        in: query
        description: The IDs of the Instances, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: isoid
        in: query
        description: List Instances by ISO
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: isvnf
        in: query
        description: flag to list vms created from VNF templates (as known as VNF appliances) or not; true if need to list VNF appliances, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: keypair
        in: query
        description: List Instances by SSH keypair name
        schema:
          type: string
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: leased
        in: query
        description: Whether to return only leased instances
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: Name of the Instance (a substring match is made against the parameter value, data for all matching Instances will be returned)
        schema:
          type: string
          maxLength: 255
      - name: networkid
        in: query
        description: List by Network ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - updateNetwork
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: retrieveonlyresourcecount
        in: query
        description: Makes the API's response contains only the resource count
        schema:
          type: boolean
      - name: securitygroupid
        in: query
        description: The security group ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.15'
      - name: serviceofferingid
        in: query
        description: List by the service offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: showicon
        in: query
        description: Flag to display the resource icon for Instances
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0.0
      - name: state
        in: query
        description: 'State of the Instance. Possible values are: Running, Stopped, Present, Destroyed, Expunged. Present is used for the state equal not destroyed.'
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: templateid
        in: query
        description: List Instances by Template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: userdata
        in: query
        description: Whether to return the Instances' User data or not. By default, User data will not be returned.
        schema:
          type: boolean
        x-cloudstack-since: 4.18.0.0
      - name: userdataid
        in: query
        description: the instances by userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.20.1
      - name: userid
        in: query
        description: The user ID that created the Instance and is under the Account that owns the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - getUser
      - name: vpcid
        in: query
        description: List Instances by VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: zoneid
        in: query
        description: The availability zone ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listVnfAppliances`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvnfappliancesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id324
                        $ref: '#/components/schemas/VirtualMachine'
                      - type: array
                        items: *id324
                required:
                - listvnfappliancesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvnfappliancesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvnfappliancesresponse
      x-cloudstack-command: listVnfAppliances
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.1
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
  /listVnfTemplates:
    get:
      operationId: listVnfTemplates
      summary: List all public, private, and privileged VNF templates.
      tags:
      - VnfTemplate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVnfTemplates
          default: listVnfTemplates
      - $ref: '#/components/parameters/response'
      - name: templatefilter
        in: query
        description: 'Possible values are "featured", "self", "selfexecutable","sharedexecutable","executable", and "community". * featured : Templates that have been marked as featured and public. * self : Templates that have been registered or created by the calling user. * selfexecutable : same as self, but only returns Templates that can be used to deploy a new Instance. * sharedexecutable : Templates ready to be deployed that have been granted to the calling user by another user. * executable : Templates that are owned by the calling user, or public Templates, that can be used to deploy an Instance. * community : Templates that have been marked as public but not featured. * all : all Templates (only usable by admins).'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: details
        in: query
        description: Comma separated list of Template details requested, value can be a list of [all, min]. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.15'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: extensionid
        in: query
        description: ID of the extension for the template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - deleteExtension
        - listExtensions
        - unregisterExtension
        - updateExtension
      - name: forcks
        in: query
        description: list templates that can be used to deploy CKS clusters
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: hypervisor
        in: query
        description: The hypervisor for which to restrict the search
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The Template ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: ids
        in: query
        description: The IDs of the Templates, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.9'
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: isready
        in: query
        description: list templates that are ready to be deployed
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: isvnf
        in: query
        description: flag to list VNF templates or not; true if need to list VNF templates, false otherwise.
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The Template name
        schema:
          type: string
          maxLength: 255
      - name: oscategoryid
        in: query
        description: the ID of the OS category for the template
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listOsCategories
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: parenttemplateid
        in: query
        description: List datadisk Templates by parent Template id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      - name: showicon
        in: query
        description: Flag to display the resource image for the Templates
        schema:
          type: boolean
      - name: showremoved
        in: query
        description: Show removed Templates as well
        schema:
          type: boolean
      - name: showunique
        in: query
        description: If set to true, list only unique Templates across zones
        schema:
          type: boolean
        x-cloudstack-since: 4.13.2
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: templatetype
        in: query
        description: the type of the template
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: zoneid
        in: query
        description: List Templates by zoneId
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listVnfTemplates`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvnftemplatesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id325
                        $ref: '#/components/schemas/Template'
                      - type: array
                        items: *id325
                required:
                - listvnftemplatesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvnftemplatesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvnftemplatesresponse
      x-cloudstack-command: listVnfTemplates
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - prepareTemplate
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateIso
      - updateTemplate
      - updateVnfTemplate
  /listVolumes:
    get:
      operationId: listVolumes
      summary: Lists all volumes.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVolumes
          default: listVolumes
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: clusterid
        in: query
        description: The cluster ID the disk volume belongs to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
      - name: diskofferingid
        in: query
        description: List volumes by disk offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: displayvolume
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: hostid
        in: query
        description: List volumes on specified host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: id
        in: query
        description: The ID of the disk volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: ids
        in: query
        description: The IDs of the volumes, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.9'
        x-cloudstack-related:
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: isencrypted
        in: query
        description: list only volumes that are encrypted
        schema:
          type: boolean
        x-cloudstack-since: 4.19.1
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: kmskeyid
        in: query
        description: List volumes by KMS Key
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.23'
        x-cloudstack-related:
        - createKMSKey
        - updateKMSKey
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: listsystemvms
        in: query
        description: List system VMs; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: name
        in: query
        description: The name of the disk volume
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The pod ID the disk volume belongs to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: retrieveonlyresourcecount
        in: query
        description: Makes the API's response contains only the resource count
        schema:
          type: boolean
      - name: serviceofferingid
        in: query
        description: List volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.19.1
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: state
        in: query
        description: 'State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.'
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: The ID of the storage pool, available to ROOT admin only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.3'
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: type
        in: query
        description: The type of disk volume
        schema:
          type: string
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: zoneid
        in: query
        description: The ID of the availability zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `listVolumes`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvolumesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      volume:
                        type: array
                        items:
                          $ref: '#/components/schemas/Volume'
                    additionalProperties: true
                required:
                - listvolumesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvolumesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvolumesresponse
      x-cloudstack-command: listVolumes
      x-cloudstack-async: false
      x-cloudstack-related:
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
  /listVolumesForImport:
    get:
      operationId: listVolumesForImport
      summary: Lists unmanaged volumes on a storage pool
      tags:
      - VolumesForImport
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVolumesForImport
          default: listVolumesForImport
      - $ref: '#/components/parameters/response'
      - name: storageid
        in: query
        description: the ID of the storage pool
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: path
        in: query
        description: the path of the volume on the storage pool
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listVolumesForImport`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvolumesforimportresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id326
                        $ref: '#/components/schemas/VolumesForImport'
                      - type: array
                        items: *id326
                required:
                - listvolumesforimportresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvolumesforimportresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvolumesforimportresponse
      x-cloudstack-command: listVolumesForImport
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.1
  /listVolumesMetrics:
    get:
      operationId: listVolumesMetrics
      summary: Lists volume metrics
      tags:
      - VolumesMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVolumesMetrics
          default: listVolumesMetrics
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: clusterid
        in: query
        description: The cluster ID the disk volume belongs to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: diskofferingid
        in: query
        description: List volumes by disk offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
        - listDiskOfferings
        - updateDiskOffering
      - name: displayvolume
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: hostid
        in: query
        description: List volumes on specified host
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      - name: id
        in: query
        description: The ID of the disk volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - checkVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: ids
        in: query
        description: The IDs of the volumes, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.9'
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - checkVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: isencrypted
        in: query
        description: list only volumes that are encrypted
        schema:
          type: boolean
        x-cloudstack-since: 4.19.1
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: kmskeyid
        in: query
        description: List volumes by KMS Key
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.23'
        x-cloudstack-related:
        - createKMSKey
        - updateKMSKey
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: listsystemvms
        in: query
        description: List system VMs; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.18'
      - name: name
        in: query
        description: The name of the disk volume
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: podid
        in: query
        description: The pod ID the disk volume belongs to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: retrieveonlyresourcecount
        in: query
        description: Makes the API's response contains only the resource count
        schema:
          type: boolean
      - name: serviceofferingid
        in: query
        description: List volumes by disk offering of a service offering. If both service offering and disk offering are passed, service offering is ignored
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.19.1
        x-cloudstack-related:
        - cloneServiceOffering
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: state
        in: query
        description: 'State of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.'
        schema:
          type: string
          maxLength: 255
      - name: storageid
        in: query
        description: The ID of the storage pool, available to ROOT admin only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.3'
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: tags
        in: query
        description: List resources by tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: type
        in: query
        description: The type of disk volume
        schema:
          type: string
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
        - updateVmNicIp
      - name: zoneid
        in: query
        description: The ID of the availability zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listVolumesMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvolumesmetricsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      volume:
                        type: array
                        items:
                          $ref: '#/components/schemas/VolumesMetric'
                    additionalProperties: true
                required:
                - listvolumesmetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvolumesmetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvolumesmetricsresponse
      x-cloudstack-command: listVolumesMetrics
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.3
  /listVolumesUsageHistory:
    get:
      operationId: listVolumesUsageHistory
      summary: Lists volume stats
      tags:
      - VolumesUsageHistory
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVolumesUsageHistory
          default: listVolumesUsageHistory
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: End date to filter stats.Use format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: id
        in: query
        description: The ID of the volume.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: ids
        in: query
        description: the IDs of the Volumes, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: startdate
        in: query
        description: Start date to filter stats.Use format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listVolumesUsageHistory`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvolumesusagehistoryresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      volume:
                        type: array
                        items:
                          $ref: '#/components/schemas/VolumesUsageHistory'
                    additionalProperties: true
                required:
                - listvolumesusagehistoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvolumesusagehistoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvolumesusagehistoryresponse
      x-cloudstack-command: listVolumesUsageHistory
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
  /listVpnConnections:
    get:
      operationId: listVpnConnections
      summary: Lists site to site VPN connection gateways
      tags:
      - VpnConnection
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVpnConnections
          default: listVpnConnections
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: ID of the VPN connection
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVpnConnection
        - listVpnConnections
        - updateVpnConnection
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      - name: vpcid
        in: query
        description: ID of VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `listVpnConnections`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpnconnectionsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id327
                        $ref: '#/components/schemas/VpnConnection'
                      - type: array
                        items: *id327
                required:
                - listvpnconnectionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpnconnectionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvpnconnectionsresponse
      x-cloudstack-command: listVpnConnections
      x-cloudstack-async: false
      x-cloudstack-related:
      - createVpnConnection
      - updateVpnConnection
  /listVpnCustomerGateways:
    get:
      operationId: listVpnCustomerGateways
      summary: Lists site to site VPN customer gateways
      tags:
      - VpnCustomerGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVpnCustomerGateways
          default: listVpnCustomerGateways
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: ID of the customer gateway
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVpnCustomerGateway
        - listVpnCustomerGateways
        - updateVpnCustomerGateway
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `listVpnCustomerGateways`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpncustomergatewaysresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id328
                        $ref: '#/components/schemas/VpnCustomerGateway'
                      - type: array
                        items: *id328
                required:
                - listvpncustomergatewaysresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpncustomergatewaysresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvpncustomergatewaysresponse
      x-cloudstack-command: listVpnCustomerGateways
      x-cloudstack-async: false
      x-cloudstack-related:
      - createVpnCustomerGateway
      - updateVpnCustomerGateway
  /listVpnGateways:
    get:
      operationId: listVpnGateways
      summary: Lists site 2 site VPN gateways
      tags:
      - VpnGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVpnGateways
          default: listVpnGateways
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: fordisplay
        in: query
        description: List resources by display flag; only ROOT admin is eligible to pass this parameter
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: ID of the VPN gateway
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVpnGateway
        - listVpnGateways
        - updateVpnGateway
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      - name: vpcid
        in: query
        description: ID of VPC
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      responses:
        '200':
          description: Successful invocation of `listVpnGateways`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpngatewaysresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id329
                        $ref: '#/components/schemas/VpnGateway'
                      - type: array
                        items: *id329
                required:
                - listvpngatewaysresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpngatewaysresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvpngatewaysresponse
      x-cloudstack-command: listVpnGateways
      x-cloudstack-async: false
      x-cloudstack-related:
      - createVpnGateway
      - updateVpnGateway
  /listVpnUsers:
    get:
      operationId: listVpnUsers
      summary: Lists VPN Users
      tags:
      - VpnUser
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVpnUsers
          default: listVpnUsers
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: The UUID of the VPN User
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addVpnUser
        - listVpnUsers
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
      - name: username
        in: query
        description: The username of the VPN User.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listVpnUsers`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpnusersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id330
                        $ref: '#/components/schemas/VpnUser'
                      - type: array
                        items: *id330
                required:
                - listvpnusersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvpnusersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvpnusersresponse
      x-cloudstack-command: listVpnUsers
      x-cloudstack-async: false
      x-cloudstack-related:
      - addVpnUser
  /listVsphereStoragePolicies:
    get:
      operationId: listVsphereStoragePolicies
      summary: List vSphere storage policies
      tags:
      - VsphereStoragePolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVsphereStoragePolicies
          default: listVsphereStoragePolicies
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: ID of the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `listVsphereStoragePolicies`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvspherestoragepoliciesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id331
                        $ref: '#/components/schemas/VsphereStoragePolicy'
                      - type: array
                        items: *id331
                required:
                - listvspherestoragepoliciesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvspherestoragepoliciesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvspherestoragepoliciesresponse
      x-cloudstack-command: listVsphereStoragePolicies
      x-cloudstack-async: false
  /listVsphereStoragePolicyCompatiblePools:
    get:
      operationId: listVsphereStoragePolicyCompatiblePools
      summary: List storage pools compatible with a vSphere storage policy
      tags:
      - VsphereStoragePolicyCompatiblePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listVsphereStoragePolicyCompatiblePools
          default: listVsphereStoragePolicyCompatiblePools
      - $ref: '#/components/parameters/response'
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: policyid
        in: query
        description: ID of the storage policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - importVsphereStoragePolicies
        - listVsphereStoragePolicies
      - name: zoneid
        in: query
        description: ID of the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `listVsphereStoragePolicyCompatiblePools`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvspherestoragepolicycompatiblepoolsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id332
                        $ref: '#/components/schemas/StoragePool'
                      - type: array
                        items: *id332
                required:
                - listvspherestoragepolicycompatiblepoolsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listvspherestoragepolicycompatiblepoolsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listvspherestoragepolicycompatiblepoolsresponse
      x-cloudstack-command: listVsphereStoragePolicyCompatiblePools
      x-cloudstack-async: false
      x-cloudstack-related:
      - cancelStorageMaintenance
      - createStoragePool
      - enableStorageMaintenance
      - findStoragePoolsForMigration
      - listStoragePools
      - syncStoragePool
      - updateStorageCapabilities
      - updateStoragePool
  /listWebhookDeliveries:
    get:
      operationId: listWebhookDeliveries
      summary: Lists Webhook deliveries
      tags:
      - WebhookDelivery
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listWebhookDeliveries
          default: listWebhookDeliveries
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: The end date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having end date equal to or before the specified date will be listed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: eventtype
        in: query
        description: The event type of the Webhook delivery
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the Webhook delivery
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: managementserverid
        in: query
        description: The ID of the management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listManagementServers
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: startdate
        in: query
        description: The start date range for the Webhook delivery (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). All deliveries having start date equal to or after the specified date will be listed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: webhookid
        in: query
        description: The ID of the Webhook
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createWebhook
        - listWebhookDeliveries
        - updateWebhook
      responses:
        '200':
          description: Successful invocation of `listWebhookDeliveries`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listwebhookdeliveriesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id333
                        $ref: '#/components/schemas/Webhook'
                      - type: array
                        items: *id333
                required:
                - listwebhookdeliveriesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listwebhookdeliveriesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listwebhookdeliveriesresponse
      x-cloudstack-command: listWebhookDeliveries
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createWebhook
      - updateWebhook
  /listWebhookFilters:
    get:
      operationId: listWebhookFilters
      summary: Lists Webhook filters
      tags:
      - WebhookFilter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listWebhookFilters
          default: listWebhookFilters
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Webhook delivery
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: webhookid
        in: query
        description: The ID of the Webhook
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createWebhook
        - listWebhookDeliveries
        - updateWebhook
      responses:
        '200':
          description: Successful invocation of `listWebhookFilters`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listwebhookfiltersresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id334
                        $ref: '#/components/schemas/WebhookFilter'
                      - type: array
                        items: *id334
                required:
                - listwebhookfiltersresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listwebhookfiltersresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listwebhookfiltersresponse
      x-cloudstack-command: listWebhookFilters
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /listWebhooks:
    get:
      operationId: listWebhooks
      summary: Lists Webhooks
      tags:
      - Webhook
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listWebhooks
          default: listWebhooks
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: List resources by Account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: List only resources belonging to the domain specified
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: The ID of the Webhook
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addWebhookFilter
        - createWebhook
        - listWebhookDeliveries
        - listWebhooks
        - updateWebhook
      - name: isrecursive
        in: query
        description: Defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.
        schema:
          type: boolean
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: listall
        in: query
        description: If set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is false. Resources dedicated to a project are listed only if using the projectid parameter.
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the Webhook
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: projectid
        in: query
        description: List objects by project; if projectid=-1 lists All Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: scope
        in: query
        description: The scope of the Webhook
        schema:
          type: string
          maxLength: 255
      - name: state
        in: query
        description: The state of the Webhook
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `listWebhooks`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listwebhooksresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                    additionalProperties:
                      oneOf:
                      - &id335
                        $ref: '#/components/schemas/Webhook'
                      - type: array
                        items: *id335
                required:
                - listwebhooksresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listwebhooksresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listwebhooksresponse
      x-cloudstack-command: listWebhooks
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - addWebhookFilter
      - createWebhook
      - listWebhookDeliveries
      - updateWebhook
  /listZones:
    get:
      operationId: listZones
      summary: Lists zones
      tags:
      - Zone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listZones
          default: listZones
      - $ref: '#/components/parameters/response'
      - name: available
        in: query
        description: True if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one Instance. Default is false.
        schema:
          type: boolean
      - name: domainid
        in: query
        description: The ID of the domain associated with the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: The ID of the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: ids
        in: query
        description: the IDs of the zones, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.19.0
        x-cloudstack-related:
        - createZone
        - listZones
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the zone
        schema:
          type: string
          maxLength: 255
      - name: networktype
        in: query
        description: The Network type of the zone that the Instance belongs to
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showcapacities
        in: query
        description: Flag to display the capacity of the zones
        schema:
          type: boolean
      - name: showicon
        in: query
        description: Flag to display the resource image for the zones
        schema:
          type: boolean
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: tags
        in: query
        description: List zones by resource tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.3'
      responses:
        '200':
          description: Successful invocation of `listZones`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listzonesresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      zone:
                        type: array
                        items:
                          $ref: '#/components/schemas/Zone'
                    additionalProperties: true
                required:
                - listzonesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listzonesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listzonesresponse
      x-cloudstack-command: listZones
      x-cloudstack-async: false
      x-cloudstack-related:
      - createZone
      - listZones
  /listZonesMetrics:
    get:
      operationId: listZonesMetrics
      summary: Lists zone metrics
      tags:
      - ZonesMetric
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: listZonesMetrics
          default: listZonesMetrics
      - $ref: '#/components/parameters/response'
      - name: available
        in: query
        description: True if you want to retrieve all available Zones. False if you only want to return the Zones from which you have at least one Instance. Default is false.
        schema:
          type: boolean
      - name: domainid
        in: query
        description: The ID of the domain associated with the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: The ID of the zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: ids
        in: query
        description: the IDs of the zones, mutually exclusive with id. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: 4.19.0
        x-cloudstack-related:
        - listZones
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the zone
        schema:
          type: string
          maxLength: 255
      - name: networktype
        in: query
        description: The Network type of the zone that the Instance belongs to
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: showcapacities
        in: query
        description: Flag to display the capacity of the zones
        schema:
          type: boolean
      - name: showicon
        in: query
        description: Flag to display the resource image for the zones
        schema:
          type: boolean
      - name: storageaccessgroup
        in: query
        description: the name of the storage access group
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: tags
        in: query
        description: List zones by resource tags (key/value pairs). Map parameter. CloudStack expects it index-encoded as `tags[0].key=k&tags[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.3'
      responses:
        '200':
          description: Successful invocation of `listZonesMetrics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listzonesmetricsresponse:
                    type: object
                    properties:
                      count:
                        type: integer
                        description: Total number of matching entities.
                      zone:
                        type: array
                        items:
                          $ref: '#/components/schemas/ZonesMetric'
                    additionalProperties: true
                required:
                - listzonesmetricsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  listzonesmetricsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - listzonesmetricsresponse
      x-cloudstack-command: listZonesMetrics
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.3
  /lockAccount:
    get:
      operationId: lockAccount
      summary: This deprecated function used to lock an Account.
      description: This deprecated function used to lock an Account. Look for the API DisableAccount instead
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: lockAccount
          default: lockAccount
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Locks the specified account.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Locks the specified Account on this domain.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      responses:
        '200':
          description: Successful invocation of `lockAccount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  lockaccountresponse:
                    oneOf:
                    - &id336
                      $ref: '#/components/schemas/Account'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id336
                        - type: array
                          items: *id336
                required:
                - lockaccountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  lockaccountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - lockaccountresponse
      x-cloudstack-command: lockAccount
      x-cloudstack-async: false
      x-cloudstack-related:
      - disableAccount
      - enableAccount
      - listAccounts
      - markDefaultZoneForAccount
      - updateAccount
  /lockUser:
    get:
      operationId: lockUser
      summary: Locks a user account
      tags:
      - User
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: lockUser
          default: lockUser
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Locks user by user ID.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
        - lockUser
      responses:
        '200':
          description: Successful invocation of `lockUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  lockuserresponse:
                    oneOf:
                    - &id337
                      $ref: '#/components/schemas/User2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id337
                        - type: array
                          items: *id337
                required:
                - lockuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  lockuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - lockuserresponse
      x-cloudstack-command: lockUser
      x-cloudstack-async: false
      x-cloudstack-related:
      - disableUser
      - getUser
      - listUsers
  /login:
    get:
      operationId: login
      summary: Logs a user into the CloudStack.
      description: Logs a user into the CloudStack. A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired.
      tags:
      - Login
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: login
          default: login
      - $ref: '#/components/parameters/response'
      - name: password
        in: query
        description: Hashed password (Default is MD5). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter See Docs section.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Username
        required: true
        schema:
          type: string
          maxLength: 255
      - name: domain
        in: query
        description: 'Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.'
        schema:
          type: string
          maxLength: 255
      - name: domainId
        in: query
        description: The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence.
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `login`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  loginresponse:
                    oneOf:
                    - &id338
                      $ref: '#/components/schemas/LoginResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id338
                        - type: array
                          items: *id338
                required:
                - loginresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  loginresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - loginresponse
      x-cloudstack-command: login
      x-cloudstack-async: false
      x-cloudstack-related:
      - oauthlogin
  /logout:
    get:
      operationId: logout
      summary: Logs out the user
      tags:
      - Logout
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: logout
          default: logout
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `logout`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  logoutresponse:
                    oneOf:
                    - &id339
                      $ref: '#/components/schemas/Logout'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id339
                        - type: array
                          items: *id339
                required:
                - logoutresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  logoutresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - logoutresponse
      x-cloudstack-command: logout
      x-cloudstack-async: false
  /manageGpuDevice:
    get:
      operationId: manageGpuDevice
      summary: Manages a GPU device
      tags:
      - GpuDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: manageGpuDevice
          default: manageGpuDevice
      - $ref: '#/components/parameters/response'
      - name: ids
        in: query
        description: comma separated list of IDs of the GPU device. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createGpuDevice
        - discoverGpuDevices
        - listGpuDevices
        - updateGpuDevice
      responses:
        '200':
          description: Successful invocation of `manageGpuDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  managegpudeviceresponse:
                    oneOf:
                    - &id340
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id340
                        - type: array
                          items: *id340
                required:
                - managegpudeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  managegpudeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - managegpudeviceresponse
      x-cloudstack-command: manageGpuDevice
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /markDefaultZoneForAccount:
    get:
      operationId: markDefaultZoneForAccount
      summary: Marks a default zone for this account
      description: |-
        Marks a default zone for this account

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: markDefaultZoneForAccount
          default: markDefaultZoneForAccount
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Name of the account that is to be marked.
        required: true
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - markDefaultZoneForAccount
        - updateAccount
      - name: domainid
        in: query
        description: Marks the account that belongs to the specified domain.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: zoneid
        in: query
        description: The Zone ID with which the account is to be marked.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `markDefaultZoneForAccount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  markdefaultzoneforaccountresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - markdefaultzoneforaccountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  markdefaultzoneforaccountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - markdefaultzoneforaccountresponse
      x-cloudstack-command: markDefaultZoneForAccount
      x-cloudstack-async: true
      x-cloudstack-since: '4.0'
      x-cloudstack-related:
      - disableAccount
      - enableAccount
      - listAccounts
      - updateAccount
      x-cloudstack-jobresult-schema: '#/components/schemas/Account'
  /migrateNetwork:
    get:
      operationId: migrateNetwork
      summary: Moves a network to another physical network
      description: |-
        Moves a network to another physical network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateNetwork
          default: migrateNetwork
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: The ID of the network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - migrateNetwork
        - updateNetwork
      - name: networkofferingid
        in: query
        description: Network offering ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: resume
        in: query
        description: True if previous network migration cmd failed
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `migrateNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratenetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migratenetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratenetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migratenetworkresponse
      x-cloudstack-command: migrateNetwork
      x-cloudstack-async: true
      x-cloudstack-since: 4.11.0
      x-cloudstack-related:
      - createNetwork
      - listNetworks
      - updateNetwork
      x-cloudstack-jobresult-schema: '#/components/schemas/Network'
  /migrateResourceToAnotherSecondaryStorage:
    get:
      operationId: migrateResourceToAnotherSecondaryStorage
      summary: migrates resources from one secondary storage to destination image store
      description: |-
        migrates resources from one secondary storage to destination image store

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ResourceToAnotherSecondaryStorage
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateResourceToAnotherSecondaryStorage
          default: migrateResourceToAnotherSecondaryStorage
      - $ref: '#/components/parameters/response'
      - name: destpool
        in: query
        description: id of the destination secondary storage pool to which the resources are to be migrated
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - listSwifts
      - name: srcpool
        in: query
        description: id of the image store from where the data is to be migrated
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - listSwifts
      - name: snapshots
        in: query
        description: id(s) of the snapshots to be migrated. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - archiveSnapshot
        - copySnapshot
        - createSnapshotFromVMSnapshot
        - listSnapshots
      - name: templates
        in: query
        description: id(s) of the templates to be migrated. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      responses:
        '200':
          description: Successful invocation of `migrateResourceToAnotherSecondaryStorage`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migrateresourcetoanothersecondarystorageresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migrateresourcetoanothersecondarystorageresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migrateresourcetoanothersecondarystorageresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migrateresourcetoanothersecondarystorageresponse
      x-cloudstack-command: migrateResourceToAnotherSecondaryStorage
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - migrateSecondaryStorageData
      x-cloudstack-jobresult-schema: '#/components/schemas/MigrateResourceToAnotherSecondaryStorageResult'
  /migrateSecondaryStorageData:
    get:
      operationId: migrateSecondaryStorageData
      summary: Migrates data objects from one secondary storage to destination image store(s)
      description: |-
        Migrates data objects from one secondary storage to destination image store(s)

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SecondaryStorageData
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateSecondaryStorageData
          default: migrateSecondaryStorageData
      - $ref: '#/components/parameters/response'
      - name: destpools
        in: query
        description: ID(s) of the destination secondary storage pool(s) to which the Templates are to be migrated. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - listSwifts
      - name: srcpool
        in: query
        description: ID of the image store from where the data is to be migrated
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addSecondaryStorage
        - listSwifts
      - name: migrationtype
        in: query
        description: 'Balance: if you want data to be distributed evenly among the destination stores, Complete: If you want to migrate the entire data from source image store to the destination store(s). Default: Complete'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `migrateSecondaryStorageData`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratesecondarystoragedataresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migratesecondarystoragedataresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratesecondarystoragedataresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migratesecondarystoragedataresponse
      x-cloudstack-command: migrateSecondaryStorageData
      x-cloudstack-async: true
      x-cloudstack-since: 4.15.0
      x-cloudstack-jobresult-schema: '#/components/schemas/MigrateResourceToAnotherSecondaryStorageResult'
  /migrateSystemVm:
    get:
      operationId: migrateSystemVm
      summary: Attempts Migration of a System VM to the host specified.
      description: |-
        Attempts Migration of a System VM to the host specified.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateSystemVm
          default: migrateSystemVm
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForSystemVm
        - migrateSystemVm
        - startSystemVm
      - name: autoselect
        in: query
        description: Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      - name: hostid
        in: query
        description: Destination Host ID to migrate Instance to
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - cancelHostAsDegraded
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: storageid
        in: query
        description: Destination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.16.0
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      responses:
        '200':
          description: Successful invocation of `migrateSystemVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratesystemvmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migratesystemvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratesystemvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migratesystemvmresponse
      x-cloudstack-command: migrateSystemVm
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForSystemVm
      - startSystemVm
      x-cloudstack-jobresult-schema: '#/components/schemas/SystemVm'
  /migrateVPC:
    get:
      operationId: migrateVPC
      summary: Moves a VPC to another physical network
      description: |-
        Moves a VPC to another physical network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPC
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateVPC
          default: migrateVPC
      - $ref: '#/components/parameters/response'
      - name: vpcid
        in: query
        description: The ID of the VPC
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      - name: vpcofferingid
        in: query
        description: VPC offering ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneVPCOffering
        - listVPCOfferings
        - updateVPCOffering
      - name: resume
        in: query
        description: True if previous network migration cmd failed
        schema:
          type: boolean
      - name: tiernetworkofferings
        in: query
        description: 'Network offering IDs for each network in the VPC. Example: tierNetworkOfferings[0].networkId=networkId1&tierNetworkOfferings[0].networkOfferingId=newNetworkofferingId1&tierNetworkOfferings[1].networkId=networkId2&tierNetworkOfferings[1].networkOfferingId=newNetworkofferingId2. Map parameter. CloudStack expects it index-encoded as `tiernetworkofferings[0].key=k&tiernetworkofferings[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `migrateVPC`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevpcresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migratevpcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevpcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migratevpcresponse
      x-cloudstack-command: migrateVPC
      x-cloudstack-async: true
      x-cloudstack-since: 4.11.0
      x-cloudstack-related:
      - createVPC
      - listVPCs
      - updateVPC
      x-cloudstack-jobresult-schema: '#/components/schemas/VPC'
  /migrateVirtualMachine:
    get:
      operationId: migrateVirtualMachine
      summary: Attempts Migration of an Instance to a different host or Root volume of the Instance to a different storage pool
      description: |-
        Attempts Migration of an Instance to a different host or Root volume of the Instance to a different storage pool

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateVirtualMachine
          default: migrateVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: autoselect
        in: query
        description: Automatically select a destination host which do not require storage migration, if hostId and storageId are not specified. false by default
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      - name: hostid
        in: query
        description: Destination Host ID to migrate Instance to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      - name: storageid
        in: query
        description: Destination storage pool ID to migrate Instance volumes to. Required for migrating the root disk volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      responses:
        '200':
          description: Successful invocation of `migrateVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migratevirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migratevirtualmachineresponse
      x-cloudstack-command: migrateVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /migrateVirtualMachineWithVolume:
    get:
      operationId: migrateVirtualMachineWithVolume
      summary: Attempts Migration of an Instance with its volumes to a different host
      description: |-
        Attempts Migration of an Instance with its volumes to a different host

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateVirtualMachineWithVolume
          default: migrateVirtualMachineWithVolume
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: autoselect
        in: query
        description: Automatically select a destination host for a running Instance, if hostId is not specified. false by default
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      - name: hostid
        in: query
        description: Destination Host ID to migrate Instance to.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: migrateto
        in: query
        description: 'Storage to pool mapping. This parameter specifies the mapping between a volume and a pool where you want to migrate that volume. Format of this parameter: migrateto[volume-index].volume=<uuid>&migrateto[volume-index].pool=<uuid>Where, [volume-index] indicates the index to identify the volume that you want to migrate, volume=<uuid> indicates the UUID of the volume that you want to migrate, and pool=<uuid> indicates the UUID of the pool where you want to migrate the volume. Example: migrateto[0].volume=<71f43cd6-69b0-4d3b-9fbc-67f50963d60b>&migrateto[0].pool=<a382f181-3d2b-4413-b92d-b8931befa7e1>&migrateto[1].volume=<88de0173-55c0-4c1c-a269-83d0279eeedf>&migrateto[1].pool=<95d6e97c-6766-4d67-9a30-c449c15011d1>&migrateto[2].volume=<1b331390-59f2-4796-9993-bf11c6e76225>&migrateto[2].pool=<41fdb564-9d3b-447d-88ed-7628f7640cbc>. Map parameter. CloudStack expects it index-encoded as `migrateto[0].key=k&migrateto[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `migrateVirtualMachineWithVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevirtualmachinewithvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migratevirtualmachinewithvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevirtualmachinewithvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migratevirtualmachinewithvolumeresponse
      x-cloudstack-command: migrateVirtualMachineWithVolume
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /migrateVolume:
    get:
      operationId: migrateVolume
      summary: Migrate volume
      description: |-
        Migrate volume

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateVolume
          default: migrateVolume
      - $ref: '#/components/parameters/response'
      - name: storageid
        in: query
        description: Destination storage pool ID to migrate the volume to
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: volumeid
        in: query
        description: The ID of the volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: livemigrate
        in: query
        description: If the volume should be live migrated when it is attached to a running Instance
        schema:
          type: boolean
      - name: newdiskofferingid
        in: query
        description: The new disk offering ID that replaces the current one used by the volume. This new disk offering is used to better reflect the new storage where the volume is going to be migrated to.
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `migrateVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migratevolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migratevolumeresponse
      x-cloudstack-command: migrateVolume
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - assignVolume
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /migrateVolumesToKMS:
    get:
      operationId: migrateVolumesToKMS
      summary: Migrates encrypted volumes to KMS
      description: |-
        Migrates encrypted volumes to KMS

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VolumesToKMS
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: migrateVolumesToKMS
          default: migrateVolumesToKMS
      - $ref: '#/components/parameters/response'
      - name: kmskeyid
        in: query
        description: KMS Key ID to use for migrating volumes
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKMSKey
        - updateKMSKey
      - name: volumeids
        in: query
        description: List of volume IDs to migrate. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: account
        in: query
        description: Migrate volumes for specific account
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Domain ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      responses:
        '200':
          description: Successful invocation of `migrateVolumesToKMS`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevolumestokmsresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - migratevolumestokmsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  migratevolumestokmsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - migratevolumestokmsresponse
      x-cloudstack-command: migrateVolumesToKMS
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - queryAsyncJobResult
      - rotateKMSKey
      x-cloudstack-jobresult-schema: '#/components/schemas/ListAsyncJobsResult'
  /moveDomain:
    get:
      operationId: moveDomain
      summary: Moves a domain and its children to a new parent domain.
      tags:
      - Domain
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: moveDomain
          default: moveDomain
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: The ID of the domain to be moved.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: parentdomainid
        in: query
        description: The ID of the new parent domain of the domain to be moved.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      responses:
        '200':
          description: Successful invocation of `moveDomain`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  movedomainresponse:
                    oneOf:
                    - &id341
                      $ref: '#/components/schemas/Domain'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id341
                        - type: array
                          items: *id341
                required:
                - movedomainresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  movedomainresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - movedomainresponse
      x-cloudstack-command: moveDomain
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0.0
      x-cloudstack-related:
      - createDomain
      - listDomains
  /moveNetworkAclItem:
    get:
      operationId: moveNetworkAclItem
      summary: Move an ACL rule to a position between two other ACL rules of the same ACL Network list
      description: |-
        Move an ACL rule to a position between two other ACL rules of the same ACL Network list

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkAclItem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: moveNetworkAclItem
          default: moveNetworkAclItem
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network ACL rule that is being moved to a new position.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: aclconsistencyhash
        in: query
        description: Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple Users are editing the same ACL rule listing. The parameter is not required. Therefore, if the User does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).
        schema:
          type: string
          maxLength: 255
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: nextaclruleid
        in: query
        description: The ID of the rule that is right after the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the last position of the network ACL list.
        schema:
          type: string
          maxLength: 255
      - name: previousaclruleid
        in: query
        description: The ID of the first rule that is right before the new position where the rule being moved is going to be placed. This value can be 'NULL' if the rule is being moved to the first position of the network ACL list.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `moveNetworkAclItem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  movenetworkaclitemresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - movenetworkaclitemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  movenetworkaclitemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - movenetworkaclitemresponse
      x-cloudstack-command: moveNetworkAclItem
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/NetworkACL'
  /moveUser:
    get:
      operationId: moveUser
      summary: Moves a user to another account in the same domain.
      tags:
      - User
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: moveUser
          default: moveUser
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the user to be moved.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
      - name: account
        in: query
        description: Moves the user under the specified account. If no account name is specified, it is necessary to provide an account id.
        schema:
          type: string
          maxLength: 255
      - name: accountid
        in: query
        description: Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      responses:
        '200':
          description: Successful invocation of `moveUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  moveuserresponse:
                    oneOf:
                    - &id342
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id342
                        - type: array
                          items: *id342
                required:
                - moveuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  moveuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - moveuserresponse
      x-cloudstack-command: moveUser
      x-cloudstack-async: false
      x-cloudstack-since: '4.11'
  /notifyBaremetalProvisionDone:
    get:
      operationId: notifyBaremetalProvisionDone
      summary: Notify provision has been done on a host.
      description: |-
        Notify provision has been done on a host. This api is for baremetal virtual router service, not for end user

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NotifyBaremetalProvisionDone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: notifyBaremetalProvisionDone
          default: notifyBaremetalProvisionDone
      - $ref: '#/components/parameters/response'
      - name: mac
        in: query
        description: MAC of the NIC used for provision
        required: true
        schema:
          type: string
          x-cloudstack-type: object
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `notifyBaremetalProvisionDone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  notifybaremetalprovisiondoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - notifybaremetalprovisiondoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  notifybaremetalprovisiondoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - notifybaremetalprovisiondoneresponse
      x-cloudstack-command: notifyBaremetalProvisionDone
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /oauthlogin:
    get:
      operationId: oauthlogin
      summary: Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout"
      description: Logs a user into the CloudStack after successful verification of OAuth secret code from the particular provider.A successful login attempt will generate a JSESSIONID cookie value that can be passed in subsequent Query command calls until the "logout" command has been issued or the session has expired.
      tags:
      - Oauthlogin
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: oauthlogin
          default: oauthlogin
      - $ref: '#/components/parameters/response'
      - name: email
        in: query
        description: Email id with which user tried to login using OAuth provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: Name of the provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: domain
        in: query
        description: 'Path of the domain that the user belongs to. Example: domain=/com/cloud/internal. If no domain is passed in, the ROOT (/) domain is assumed.'
        schema:
          type: string
          maxLength: 255
      - name: domainId
        in: query
        description: The id of the domain that the user belongs to. If both domain and domainId are passed in, "domainId" parameter takes precedence.
        schema:
          type: integer
          format: int64
      - name: secretcode
        in: query
        description: Code that is provided by OAuth provider (Eg. google, github) after successful login
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `oauthlogin`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  oauthloginresponse:
                    oneOf:
                    - &id343
                      $ref: '#/components/schemas/LoginResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id343
                        - type: array
                          items: *id343
                required:
                - oauthloginresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  oauthloginresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - oauthloginresponse
      x-cloudstack-command: oauthlogin
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /patchSystemVm:
    get:
      operationId: patchSystemVm
      summary: Attempts to live patch systemVMs - CPVM, SSVM
      description: |-
        Attempts to live patch systemVMs - CPVM, SSVM

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: patchSystemVm
          default: patchSystemVm
      - $ref: '#/components/parameters/response'
      - name: forced
        in: query
        description: If true, initiates copy of scripts and restart of the agent, even if the scripts version matches.To be used with ID parameter only
        schema:
          type: boolean
      - name: id
        in: query
        description: Patches System VM - CPVM/SSVM with the specified ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForSystemVm
        - listSystemVms
        - migrateSystemVm
        - startSystemVm
      responses:
        '200':
          description: Successful invocation of `patchSystemVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  patchsystemvmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - patchsystemvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  patchsystemvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - patchsystemvmresponse
      x-cloudstack-command: patchSystemVm
      x-cloudstack-async: true
      x-cloudstack-since: 4.17.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /prepareForMaintenance:
    get:
      operationId: prepareForMaintenance
      summary: Prepares management server for maintenance by preventing new jobs from being accepted after completion of active jobs and migrating the agents
      tags:
      - ForMaintenance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: prepareForMaintenance
          default: prepareForMaintenance
      - $ref: '#/components/parameters/response'
      - name: managementserverid
        in: query
        description: The UUID of the management server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listManagementServers
      - name: algorithm
        in: query
        description: indirect agents load balancer algorithm (static, roundrobin, shuffle); when this is not set, already configured algorithm from setting 'indirect.agent.lb.algorithm' is considered
        schema:
          type: string
          maxLength: 255
      - name: forced
        in: query
        description: Force management server to maintenance after the maintenance window timeout, default is false
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `prepareForMaintenance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  prepareformaintenanceresponse:
                    oneOf:
                    - &id344
                      $ref: '#/components/schemas/CancelMaintenanceResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id344
                        - type: array
                          items: *id344
                required:
                - prepareformaintenanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  prepareformaintenanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - prepareformaintenanceresponse
      x-cloudstack-command: prepareForMaintenance
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - cancelShutdown
      - prepareForShutdown
      - readyForShutdown
  /prepareForShutdown:
    get:
      operationId: prepareForShutdown
      summary: Prepares CloudStack for a safe manual shutdown by preventing new jobs from being accepted
      tags:
      - ForShutdown
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: prepareForShutdown
          default: prepareForShutdown
      - $ref: '#/components/parameters/response'
      - name: managementserverid
        in: query
        description: The UUID of the management server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `prepareForShutdown`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  prepareforshutdownresponse:
                    oneOf:
                    - &id345
                      $ref: '#/components/schemas/CancelMaintenanceResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id345
                        - type: array
                          items: *id345
                required:
                - prepareforshutdownresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  prepareforshutdownresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - prepareforshutdownresponse
      x-cloudstack-command: prepareForShutdown
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /prepareHostForMaintenance:
    get:
      operationId: prepareHostForMaintenance
      summary: Prepares a host for maintenance.
      description: |-
        Prepares a host for maintenance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - HostForMaintenance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: prepareHostForMaintenance
          default: prepareHostForMaintenance
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The host ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `prepareHostForMaintenance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  preparehostformaintenanceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - preparehostformaintenanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  preparehostformaintenanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - preparehostformaintenanceresponse
      x-cloudstack-command: prepareHostForMaintenance
      x-cloudstack-async: true
      x-cloudstack-related:
      - addBaremetalHost
      - addHost
      - cancelHostAsDegraded
      - cancelHostMaintenance
      - declareHostAsDegraded
      - listHosts
      - reconnectHost
      x-cloudstack-jobresult-schema: '#/components/schemas/Host'
  /prepareTemplate:
    get:
      operationId: prepareTemplate
      summary: Load Template into primary storage
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: prepareTemplate
          default: prepareTemplate
      - $ref: '#/components/parameters/response'
      - name: templateid
        in: query
        description: Template ID of the Template to be prepared in primary storage(s).
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateTemplate
        - updateVnfTemplate
      - name: zoneid
        in: query
        description: Zone ID of the Template to be prepared in primary storage(s).
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: storageid
        in: query
        description: Storage pool ID of the primary storage pool to which the Template should be prepared. If it is not provided the Template is prepared on all the available primary storage pools.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
      responses:
        '200':
          description: Successful invocation of `prepareTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  preparetemplateresponse:
                    oneOf:
                    - &id346
                      $ref: '#/components/schemas/Template'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id346
                        - type: array
                          items: *id346
                required:
                - preparetemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  preparetemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - preparetemplateresponse
      x-cloudstack-command: prepareTemplate
      x-cloudstack-async: false
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateTemplate
      - updateVnfTemplate
  /provisionCertificate:
    get:
      operationId: provisionCertificate
      summary: Issues and propagates client certificate on a connected host/agent using configured CA plugin
      description: |-
        Issues and propagates client certificate on a connected host/agent using configured CA plugin

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Certificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: provisionCertificate
          default: provisionCertificate
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: The host/agent ID to which the certificate has to be provisioned (issued and propagated)
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: forced
        in: query
        description: When true, uses SSH to re-provision the agent's certificate, bypassing the NIO agent connection. Use this when agents are disconnected due to a CA change. Supported for KVM hosts and SystemVMs. Default is false
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: provider
        in: query
        description: Name of the CA service provider, otherwise the default configured provider plugin will be used
        schema:
          type: string
          maxLength: 255
      - name: reconnect
        in: query
        description: Whether to attempt reconnection with host/agent after successful deployment of certificate. When option is not provided, configured global setting is used
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `provisionCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  provisioncertificateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - provisioncertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  provisioncertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - provisioncertificateresponse
      x-cloudstack-command: provisionCertificate
      x-cloudstack-async: true
      x-cloudstack-since: 4.11.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /provisionTemplateDirectDownloadCertificate:
    get:
      operationId: provisionTemplateDirectDownloadCertificate
      summary: Provisions a host with a direct download certificate
      tags:
      - TemplateDirectDownloadCertificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: provisionTemplateDirectDownloadCertificate
          default: provisionTemplateDirectDownloadCertificate
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: The host to provision the certificate
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      - name: id
        in: query
        description: The id of the direct download certificate to provision
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `provisionTemplateDirectDownloadCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  provisiontemplatedirectdownloadcertificateresponse:
                    oneOf:
                    - &id347
                      $ref: '#/components/schemas/TemplateDirectDownloadCertificate2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id347
                        - type: array
                          items: *id347
                required:
                - provisiontemplatedirectdownloadcertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  provisiontemplatedirectdownloadcertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - provisiontemplatedirectdownloadcertificateresponse
      x-cloudstack-command: provisionTemplateDirectDownloadCertificate
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /purgeExpungedResources:
    get:
      operationId: purgeExpungedResources
      summary: Purge expunged resources
      description: |-
        Purge expunged resources

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PurgeExpungedResource
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: purgeExpungedResources
          default: purgeExpungedResources
      - $ref: '#/components/parameters/response'
      - name: batchsize
        in: query
        description: The size of batch used during purging
        schema:
          type: integer
          format: int64
      - name: enddate
        in: query
        description: The end date range of the expunged resources used for purging (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: resourcetype
        in: query
        description: 'The type of the resource which need to be purged. Supported types: VirtualMachine'
        schema:
          type: string
          maxLength: 255
      - name: startdate
        in: query
        description: The start date range of the expunged resources used for purging (use format "yyyy-MM-dd" or "yyyy-MM-dd HH:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `purgeExpungedResources`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  purgeexpungedresourcesresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - purgeexpungedresourcesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  purgeexpungedresourcesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - purgeexpungedresourcesresponse
      x-cloudstack-command: purgeExpungedResources
      x-cloudstack-async: true
      x-cloudstack-since: '4.20'
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /queryAsyncJobResult:
    get:
      operationId: queryAsyncJobResult
      summary: Retrieves the current status of asynchronous job.
      tags:
      - AsyncJobResult
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: queryAsyncJobResult
          default: queryAsyncJobResult
      - $ref: '#/components/parameters/response'
      - name: jobid
        in: query
        description: The ID of the asynchronous job
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - queryAsyncJobResult
      - name: resourceid
        in: query
        description: the ID of the resource associated with the job
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.22.1
      - name: resourcetype
        in: query
        description: the type of the resource associated with the job
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.22.1
      responses:
        '200':
          description: Successful invocation of `queryAsyncJobResult`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  queryasyncjobresultresponse:
                    oneOf:
                    - &id348
                      $ref: '#/components/schemas/ListAsyncJobsResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id348
                        - type: array
                          items: *id348
                required:
                - queryasyncjobresultresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  queryasyncjobresultresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - queryasyncjobresultresponse
      x-cloudstack-command: queryAsyncJobResult
      x-cloudstack-async: false
  /quotaIsEnabled:
    get:
      operationId: quotaIsEnabled
      summary: Return true if the plugin is enabled
      tags:
      - QuotaIsEnabled
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: quotaIsEnabled
          default: quotaIsEnabled
      - $ref: '#/components/parameters/response'
      responses:
        '200':
          description: Successful invocation of `quotaIsEnabled`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  quotaisenabledresponse:
                    oneOf:
                    - &id349
                      $ref: '#/components/schemas/QuotaIsEnabled'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id349
                        - type: array
                          items: *id349
                required:
                - quotaisenabledresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  quotaisenabledresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - quotaisenabledresponse
      x-cloudstack-command: quotaIsEnabled
      x-cloudstack-async: false
      x-cloudstack-since: 4.7.0
  /readyForShutdown:
    get:
      operationId: readyForShutdown
      summary: Returns the status of CloudStack, whether a shutdown has been triggered and if ready to shutdown
      tags:
      - ReadyForShutdown
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: readyForShutdown
          default: readyForShutdown
      - $ref: '#/components/parameters/response'
      - name: managementserverid
        in: query
        description: The UUID of the management server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listManagementServers
      responses:
        '200':
          description: Successful invocation of `readyForShutdown`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  readyforshutdownresponse:
                    oneOf:
                    - &id350
                      $ref: '#/components/schemas/CancelMaintenanceResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id350
                        - type: array
                          items: *id350
                required:
                - readyforshutdownresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  readyforshutdownresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - readyforshutdownresponse
      x-cloudstack-command: readyForShutdown
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - prepareForShutdown
  /rebootRouter:
    get:
      operationId: rebootRouter
      summary: Starts a router.
      description: |-
        Starts a router.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Router
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: rebootRouter
          default: rebootRouter
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the router
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - rebootRouter
        - stopInternalLoadBalancerVM
      - name: forced
        in: query
        description: Force reboot the router (Router is force Stopped and then Started)
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      responses:
        '200':
          description: Successful invocation of `rebootRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rebootrouterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - rebootrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rebootrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - rebootrouterresponse
      x-cloudstack-command: rebootRouter
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForRouter
      - listInternalLoadBalancerVMs
      - listRouters
      - stopInternalLoadBalancerVM
      x-cloudstack-jobresult-schema: '#/components/schemas/Router'
  /rebootSystemVm:
    get:
      operationId: rebootSystemVm
      summary: Reboots a system VM.
      description: |-
        Reboots a system VM.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: rebootSystemVm
          default: rebootSystemVm
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the System VM
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForSystemVm
        - destroySystemVm
        - listSystemVms
        - migrateSystemVm
        - rebootSystemVm
        - scaleSystemVm
        - startSystemVm
        - stopSystemVm
      - name: forced
        in: query
        description: Force reboot the System VM (System VM is Stopped and then Started)
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      responses:
        '200':
          description: Successful invocation of `rebootSystemVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rebootsystemvmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - rebootsystemvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rebootsystemvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - rebootsystemvmresponse
      x-cloudstack-command: rebootSystemVm
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForSystemVm
      - destroySystemVm
      - listSystemVms
      - migrateSystemVm
      - scaleSystemVm
      - startSystemVm
      - stopSystemVm
      x-cloudstack-jobresult-schema: '#/components/schemas/SystemVm'
  /rebootVirtualMachine:
    get:
      operationId: rebootVirtualMachine
      summary: Reboots  an Instance.
      description: |-
        Reboots  an Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: rebootVirtualMachine
          default: rebootVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: bootintosetup
        in: query
        description: Boot into hardware setup menu or not
        schema:
          type: boolean
        x-cloudstack-since: 4.15.0.0
      - name: forced
        in: query
        description: Force reboot the Instance (It is Stopped and then Started)
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      responses:
        '200':
          description: Successful invocation of `rebootVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rebootvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - rebootvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rebootvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - rebootvirtualmachineresponse
      x-cloudstack-command: rebootVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /reconnectHost:
    get:
      operationId: reconnectHost
      summary: Reconnects a host.
      description: |-
        Reconnects a host.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Host
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: reconnectHost
          default: reconnectHost
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The host ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `reconnectHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  reconnecthostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - reconnecthostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  reconnecthostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - reconnecthostresponse
      x-cloudstack-command: reconnectHost
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/Host'
  /recoverSharedFileSystem:
    get:
      operationId: recoverSharedFileSystem
      summary: Recover a Shared FileSystem by id
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: recoverSharedFileSystem
          default: recoverSharedFileSystem
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the shared filesystem to recover
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
        - changeSharedFileSystemServiceOffering
        - listSharedFileSystems
        - startSharedFileSystem
        - stopSharedFileSystem
      responses:
        '200':
          description: Successful invocation of `recoverSharedFileSystem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  recoversharedfilesystemresponse:
                    oneOf:
                    - &id351
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id351
                        - type: array
                          items: *id351
                required:
                - recoversharedfilesystemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  recoversharedfilesystemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - recoversharedfilesystemresponse
      x-cloudstack-command: recoverSharedFileSystem
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /recoverVirtualMachine:
    get:
      operationId: recoverVirtualMachine
      summary: Recovers  an Instance.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: recoverVirtualMachine
          default: recoverVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `recoverVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  recovervirtualmachineresponse:
                    oneOf:
                    - &id352
                      $ref: '#/components/schemas/VirtualMachine'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id352
                        - type: array
                          items: *id352
                required:
                - recovervirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  recovervirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - recovervirtualmachineresponse
      x-cloudstack-command: recoverVirtualMachine
      x-cloudstack-async: false
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
  /recoverVolume:
    get:
      operationId: recoverVolume
      summary: Recovers a Destroy volume.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: recoverVolume
          default: recoverVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      responses:
        '200':
          description: Successful invocation of `recoverVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  recovervolumeresponse:
                    oneOf:
                    - &id353
                      $ref: '#/components/schemas/Volume'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id353
                        - type: array
                          items: *id353
                required:
                - recovervolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  recovervolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - recovervolumeresponse
      x-cloudstack-command: recoverVolume
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
      x-cloudstack-related:
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
  /registerCniConfiguration:
    get:
      operationId: registerCniConfiguration
      summary: Register a CNI Configuration to be used with CKS cluster
      tags:
      - CniConfiguration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerCniConfiguration
          default: registerCniConfiguration
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the user data
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: an optional account for the user data. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: cniconfig
        in: query
        description: CNI Configuration content to be registered as User data
        schema:
          type: string
          maxLength: 1048576
      - name: domainid
        in: query
        description: an optional domainId for the user data. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: params
        in: query
        description: comma separated list of variables declared in user data content
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: an optional project for the user data
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `registerCniConfiguration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registercniconfigurationresponse:
                    oneOf:
                    - &id354
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id354
                        - type: array
                          items: *id354
                required:
                - registercniconfigurationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registercniconfigurationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registercniconfigurationresponse
      x-cloudstack-command: registerCniConfiguration
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /registerExtension:
    get:
      operationId: registerExtension
      summary: Register an extension with a resource
      tags:
      - Extension
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerExtension
          default: registerExtension
      - $ref: '#/components/parameters/response'
      - name: extensionid
        in: query
        description: ID of the extension
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - deleteExtension
        - listExtensions
        - registerExtension
        - unregisterExtension
        - updateExtension
      - name: resourceid
        in: query
        description: ID of the resource to register the extension with
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `registerExtension`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registerextensionresponse:
                    oneOf:
                    - &id355
                      $ref: '#/components/schemas/Extension'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id355
                        - type: array
                          items: *id355
                required:
                - registerextensionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registerextensionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registerextensionresponse
      x-cloudstack-command: registerExtension
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - deleteExtension
      - listExtensions
      - unregisterExtension
      - updateExtension
  /registerIso:
    get:
      operationId: registerIso
      summary: Registers an existing ISO into the CloudStack Cloud.
      tags:
      - Iso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerIso
          default: registerIso
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the ISO
        required: true
        schema:
          type: string
          maxLength: 251
      - name: url
        in: query
        description: The URL to where the ISO is currently being hosted
        required: true
        schema:
          type: string
          maxLength: 2048
      - name: zoneid
        in: query
        description: The ID of the zone you wish to register the ISO to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: account
        in: query
        description: An optional Account name. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the ISO. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: bootable
        in: query
        description: True if this ISO is bootable. If not passed explicitly its assumed to be true
        schema:
          type: boolean
      - name: checksum
        in: query
        description: |-
          The checksum value of this ISO. The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: directdownload
        in: query
        description: True if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment
        schema:
          type: boolean
      - name: displaytext
        in: query
        description: The display text of the ISO, defaults to the 'name'
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: An optional domainId. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: imagestoreuuid
        in: query
        description: Image store UUID
        schema:
          type: string
          maxLength: 255
      - name: isdynamicallyscalable
        in: query
        description: True if ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
        schema:
          type: boolean
      - name: isextractable
        in: query
        description: True if the ISO or its derivatives are extractable; default is false
        schema:
          type: boolean
      - name: isfeatured
        in: query
        description: True if you want this ISO to be featured
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: True if you want to register the ISO to be publicly available to all Users, false otherwise.
        schema:
          type: boolean
      - name: ostypeid
        in: query
        description: The ID of the OS type that best represents the OS of this ISO. If the ISO is bootable this parameter needs to be passed
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
      - name: passwordenabled
        in: query
        description: True if password reset feature is supported; default is false
        schema:
          type: boolean
      - name: projectid
        in: query
        description: Register ISO for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `registerIso`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registerisoresponse:
                    oneOf:
                    - &id356
                      $ref: '#/components/schemas/Template'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id356
                        - type: array
                          items: *id356
                required:
                - registerisoresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registerisoresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registerisoresponse
      x-cloudstack-command: registerIso
      x-cloudstack-async: false
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - prepareTemplate
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateIso
      - updateTemplate
      - updateVnfTemplate
  /registerNetscalerControlCenter:
    get:
      operationId: registerNetscalerControlCenter
      summary: Adds a netscaler control center device
      description: |-
        Adds a netscaler control center device

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetscalerControlCenter
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerNetscalerControlCenter
          default: registerNetscalerControlCenter
      - $ref: '#/components/parameters/response'
      - name: ipaddress
        in: query
        description: URL of the netscaler controlcenter appliance.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: numretries
        in: query
        description: Credentials to reach netscaler controlcenter device
        required: true
        schema:
          type: integer
          format: int32
      - name: password
        in: query
        description: Credentials to reach netscaler controlcenter  device
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Credentials to reach netscaler controlcenter device
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `registerNetscalerControlCenter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registernetscalercontrolcenterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - registernetscalercontrolcenterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registernetscalercontrolcenterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registernetscalercontrolcenterresponse
      x-cloudstack-command: registerNetscalerControlCenter
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNetscalerLoadBalancer
      x-cloudstack-jobresult-schema: '#/components/schemas/NetscalerLoadBalancer'
  /registerNetscalerServicePackage:
    get:
      operationId: registerNetscalerServicePackage
      summary: Registers NCC Service Package
      tags:
      - NetscalerServicePackage
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerNetscalerServicePackage
          default: registerNetscalerServicePackage
      - $ref: '#/components/parameters/response'
      - name: description
        in: query
        description: Description of Service Package
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the service Package.
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `registerNetscalerServicePackage`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registernetscalerservicepackageresponse:
                    oneOf:
                    - &id357
                      $ref: '#/components/schemas/ListRegisteredServicePackagesResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id357
                        - type: array
                          items: *id357
                required:
                - registernetscalerservicepackageresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registernetscalerservicepackageresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registernetscalerservicepackageresponse
      x-cloudstack-command: registerNetscalerServicePackage
      x-cloudstack-async: false
      x-cloudstack-related:
      - listRegisteredServicePackages
  /registerOauthProvider:
    get:
      operationId: registerOauthProvider
      summary: Register the OAuth2 provider in CloudStack
      tags:
      - OauthProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerOauthProvider
          default: registerOauthProvider
      - $ref: '#/components/parameters/response'
      - name: clientid
        in: query
        description: Client ID pre-registered in the specific OAuth provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: Description of the OAuth Provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: Name of the provider from the list of OAuth providers supported in CloudStack
        required: true
        schema:
          type: string
          maxLength: 255
      - name: redirecturi
        in: query
        description: Redirect URI pre-registered in the specific OAuth provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: secretkey
        in: query
        description: Secret Key pre-registered in the specific OAuth provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: authorizeurl
        in: query
        description: Authorize URL for OAuth initialization (only required for keycloak provider)
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: details
        in: query
        description: 'Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: domain
        in: query
        description: Domain path for domain-specific OAuth provider. Ignored when Domain ID is passed.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: domainid
        in: query
        description: Domain ID for domain-specific OAuth provider. If not provided, registers as global provider
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: tokenurl
        in: query
        description: Token URL for OAuth finalization (only required for keycloak provider)
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      responses:
        '200':
          description: Successful invocation of `registerOauthProvider`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registeroauthproviderresponse:
                    oneOf:
                    - &id358
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id358
                        - type: array
                          items: *id358
                required:
                - registeroauthproviderresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registeroauthproviderresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registeroauthproviderresponse
      x-cloudstack-command: registerOauthProvider
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /registerSSHKeyPair:
    get:
      operationId: registerSSHKeyPair
      summary: Register a public key in a keypair under a certain name
      tags:
      - SSHKeyPair
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerSSHKeyPair
          default: registerSSHKeyPair
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the keypair
        required: true
        schema:
          type: string
          maxLength: 255
      - name: publickey
        in: query
        description: Public key material of the keypair
        required: true
        schema:
          type: string
          maxLength: 5120
      - name: account
        in: query
        description: An optional Account for the SSH key. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the SSH key. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: projectid
        in: query
        description: An optional project for the SSH key
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `registerSSHKeyPair`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registersshkeypairresponse:
                    oneOf:
                    - &id359
                      $ref: '#/components/schemas/SSHKeyPair2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id359
                        - type: array
                          items: *id359
                required:
                - registersshkeypairresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registersshkeypairresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registersshkeypairresponse
      x-cloudstack-command: registerSSHKeyPair
      x-cloudstack-async: false
      x-cloudstack-related:
      - listSSHKeyPairs
  /registerTemplate:
    get:
      operationId: registerTemplate
      summary: Registers an existing Template into the CloudStack cloud.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerTemplate
          default: registerTemplate
      - $ref: '#/components/parameters/response'
      - name: format
        in: query
        description: The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hypervisor
        in: query
        description: The target hypervisor for the Template
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Template
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The URL of where the Template is hosted. Possible URL include http:// and https://
        required: true
        schema:
          type: string
          maxLength: 2048
      - name: account
        in: query
        description: An optional accountName. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: bits
        in: query
        description: 32 or 64 bits support. 64 by default
        schema:
          type: integer
          format: int32
      - name: checksum
        in: query
        description: |-
          The checksum value of this Template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: deployasis
        in: query
        description: (VMware only) true if Instance deployments should preserve all the configurations defined for this Template
        schema:
          type: boolean
        x-cloudstack-since: 4.15.1
      - name: details
        in: query
        description: 'Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: directdownload
        in: query
        description: True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment
        schema:
          type: boolean
      - name: displaytext
        in: query
        description: The display text of the Template, defaults to 'name'.
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: An optional domainId. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: extensionid
        in: query
        description: ID of the extension
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listExtensions
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: forcks
        in: query
        description: if true, the templates would be available for deploying CKS clusters
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: isdynamicallyscalable
        in: query
        description: True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory
        schema:
          type: boolean
      - name: isextractable
        in: query
        description: True if the Template or its derivatives are extractable; default is false
        schema:
          type: boolean
      - name: isfeatured
        in: query
        description: True if this Template is a featured Template, false otherwise
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: True if the Template is available to all accounts; default is true
        schema:
          type: boolean
      - name: isrouting
        in: query
        description: True if the Template type is routing i.e., if Template is used to deploy router
        schema:
          type: boolean
      - name: ostypeid
        in: query
        description: The ID of the OS Type that best represents the OS of this Template. Not applicable with VMware, as we honour what is defined in the Template
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: passwordenabled
        in: query
        description: True if the Template supports the password reset feature; default is false
        schema:
          type: boolean
      - name: projectid
        in: query
        description: Register Template for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: requireshvm
        in: query
        description: True if this Template requires HVM
        schema:
          type: boolean
      - name: sshkeyenabled
        in: query
        description: True if the Template supports the sshkey upload feature; default is false
        schema:
          type: boolean
      - name: templatetag
        in: query
        description: The tag for this Template.
        schema:
          type: string
          maxLength: 255
      - name: templatetype
        in: query
        description: 'the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: zoneid
        in: query
        description: The ID of the zone the Template is to be hosted on
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: zoneids
        in: query
        description: A list of zone IDs where the Template will be hosted. Use this parameter if the Template needs to be registered to multiple zones in one go. Use zoneid if the Template needs to be registered to only one zone.Passing only -1 to this will cause the Template to be registered as a cross zone Template and will be copied to all zones. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `registerTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registertemplateresponse:
                    oneOf:
                    - &id360
                      $ref: '#/components/schemas/Template'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id360
                        - type: array
                          items: *id360
                required:
                - registertemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registertemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registertemplateresponse
      x-cloudstack-command: registerTemplate
      x-cloudstack-async: false
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateVnfTemplate
  /registerUserData:
    get:
      operationId: registerUserData
      summary: Register a new User Data.
      tags:
      - UserData
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerUserData
          default: registerUserData
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: Name of the user data
        required: true
        schema:
          type: string
          maxLength: 255
      - name: userdata
        in: query
        description: Base64 encoded User Data content. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 32KB of data after base64 encoding, which can be increased upto 1MB using the vm.userdata.max.length setting
        required: true
        schema:
          type: string
          maxLength: 1048576
      - name: account
        in: query
        description: an optional account for the user data. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: an optional domainId for the user data. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: params
        in: query
        description: comma separated list of variables declared in user data content
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: an optional project for the user data
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
      responses:
        '200':
          description: Successful invocation of `registerUserData`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registeruserdataresponse:
                    oneOf:
                    - &id361
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id361
                        - type: array
                          items: *id361
                required:
                - registeruserdataresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registeruserdataresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registeruserdataresponse
      x-cloudstack-command: registerUserData
      x-cloudstack-async: false
      x-cloudstack-since: '4.18'
  /registerUserKeys:
    get:
      operationId: registerUserKeys
      summary: Registers an API key pair (API and secret keys) for a user.
      tags:
      - UserKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerUserKeys
          default: registerUserKeys
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the user.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
      - name: description
        in: query
        description: API key pair description.
        schema:
          type: string
          maxLength: 1024
        x-cloudstack-since: 4.23.0
      - name: enddate
        in: query
        description: 'Expiration date of the API key pair. The recommended format is "yyyy-MM-dd''T''HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "23:59:59"). If the recommended format is not used, the date will be considered in the server timezone. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".'
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: name
        in: query
        description: API key pair name.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: rules
        in: query
        description: 'The rules of the API key pair. If no rules are informed, defaults to allowing all account permissions. Otherwise, only the explicitly informed permissions for the key pair will be considered. Lower indexed rules take precedence over higher. Thus, in the following example: "rules[0].rule=deleteUserKeys rules[0].permission=deny rules[1].rule=*UserKey* rules[1].permission=allow", all rules matching the expression "*UserKeys*" will be allowed, except for "deleteUserKeys". Map parameter. CloudStack expects it index-encoded as `rules[0].key=k&rules[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.23.0
      - name: startdate
        in: query
        description: 'Start date of the API key pair. The recommended format is "yyyy-MM-dd''T''HH:mm:ssZ" (e.g.: "2023-01-01T12:00:00+0100"); however, the following formats are also accepted: "yyyy-MM-dd HH:mm:ss" (e.g.: "2023-01-01 12:00:00") and "yyyy-MM-dd" (e.g.: "2023-01-01" - if the time is not added, it will be interpreted as "00:00:00"). If the recommended format is not used, the date will be considered in the server timezone. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".'
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
        x-cloudstack-since: 4.23.0
      responses:
        '200':
          description: Successful invocation of `registerUserKeys`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registeruserkeysresponse:
                    oneOf:
                    - &id362
                      $ref: '#/components/schemas/UserKey2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id362
                        - type: array
                          items: *id362
                required:
                - registeruserkeysresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registeruserkeysresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registeruserkeysresponse
      x-cloudstack-command: registerUserKeys
      x-cloudstack-async: false
      x-cloudstack-related:
      - listUserKeys
  /registerVnfTemplate:
    get:
      operationId: registerVnfTemplate
      summary: Registers an existing VNF template into the CloudStack cloud.
      tags:
      - VnfTemplate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: registerVnfTemplate
          default: registerVnfTemplate
      - $ref: '#/components/parameters/response'
      - name: format
        in: query
        description: The format for the Template. Possible values include QCOW2, RAW, VHD and OVA.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hypervisor
        in: query
        description: The target hypervisor for the Template
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Template
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The URL of where the Template is hosted. Possible URL include http:// and https://
        required: true
        schema:
          type: string
          maxLength: 2048
      - name: account
        in: query
        description: An optional accountName. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the template. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: bits
        in: query
        description: 32 or 64 bits support. 64 by default
        schema:
          type: integer
          format: int32
      - name: checksum
        in: query
        description: |-
          The checksum value of this Template. The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: deployasis
        in: query
        description: (VMware only) true if Instance deployments should preserve all the configurations defined for this Template
        schema:
          type: boolean
        x-cloudstack-since: 4.15.1
      - name: details
        in: query
        description: 'Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: directdownload
        in: query
        description: True if Template should bypass Secondary Storage and be downloaded to Primary Storage on deployment
        schema:
          type: boolean
      - name: displaytext
        in: query
        description: The display text of the Template, defaults to 'name'.
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: An optional domainId. If the account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: extensionid
        in: query
        description: ID of the extension
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - listExtensions
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: forcks
        in: query
        description: if true, the templates would be available for deploying CKS clusters
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: isdynamicallyscalable
        in: query
        description: True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory
        schema:
          type: boolean
      - name: isextractable
        in: query
        description: True if the Template or its derivatives are extractable; default is false
        schema:
          type: boolean
      - name: isfeatured
        in: query
        description: True if this Template is a featured Template, false otherwise
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: True if the Template is available to all accounts; default is true
        schema:
          type: boolean
      - name: isrouting
        in: query
        description: True if the Template type is routing i.e., if Template is used to deploy router
        schema:
          type: boolean
      - name: ostypeid
        in: query
        description: The ID of the OS Type that best represents the OS of this Template. Not applicable with VMware, as we honour what is defined in the Template
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: passwordenabled
        in: query
        description: True if the Template supports the password reset feature; default is false
        schema:
          type: boolean
      - name: projectid
        in: query
        description: Register Template for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: requireshvm
        in: query
        description: True if this Template requires HVM
        schema:
          type: boolean
      - name: sshkeyenabled
        in: query
        description: True if the Template supports the sshkey upload feature; default is false
        schema:
          type: boolean
      - name: templatetag
        in: query
        description: The tag for this Template.
        schema:
          type: string
          maxLength: 255
      - name: templatetype
        in: query
        description: 'the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: vnfdetails
        in: query
        description: 'VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0. Map parameter. CloudStack expects it index-encoded as `vnfdetails[0].key=k&vnfdetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: vnfnics
        in: query
        description: 'VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue.  Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC. Map parameter. CloudStack expects it index-encoded as `vnfnics[0].key=k&vnfnics[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: zoneid
        in: query
        description: The ID of the zone the Template is to be hosted on
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: zoneids
        in: query
        description: A list of zone IDs where the Template will be hosted. Use this parameter if the Template needs to be registered to multiple zones in one go. Use zoneid if the Template needs to be registered to only one zone.Passing only -1 to this will cause the Template to be registered as a cross zone Template and will be copied to all zones. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `registerVnfTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registervnftemplateresponse:
                    oneOf:
                    - &id363
                      $ref: '#/components/schemas/Template'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id363
                        - type: array
                          items: *id363
                required:
                - registervnftemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  registervnftemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - registervnftemplateresponse
      x-cloudstack-command: registerVnfTemplate
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateVnfTemplate
  /releaseASNumber:
    get:
      operationId: releaseASNumber
      summary: Releases an AS Number back to the pool
      tags:
      - ASNumber
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseASNumber
          default: releaseASNumber
      - $ref: '#/components/parameters/response'
      - name: asnumber
        in: query
        description: the AS Number to be released
        required: true
        schema:
          type: integer
          format: int64
      - name: zoneid
        in: query
        description: the zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `releaseASNumber`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releaseasnumberresponse:
                    oneOf:
                    - &id364
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id364
                        - type: array
                          items: *id364
                required:
                - releaseasnumberresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releaseasnumberresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releaseasnumberresponse
      x-cloudstack-command: releaseASNumber
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
  /releaseBgpPeer:
    get:
      operationId: releaseBgpPeer
      summary: Releases an existing dedicated Bgp Peer.
      description: |-
        Releases an existing dedicated Bgp Peer.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BgpPeer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseBgpPeer
          default: releaseBgpPeer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the Bgp Peer
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - releaseBgpPeer
      responses:
        '200':
          description: Successful invocation of `releaseBgpPeer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasebgppeerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - releasebgppeerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasebgppeerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasebgppeerresponse
      x-cloudstack-command: releaseBgpPeer
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/BgpPeer'
  /releaseDedicatedCluster:
    get:
      operationId: releaseDedicatedCluster
      summary: Release the dedication for cluster
      description: |-
        Release the dedication for cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseDedicatedCluster
          default: releaseDedicatedCluster
      - $ref: '#/components/parameters/response'
      - name: clusterid
        in: query
        description: The ID of the Cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      responses:
        '200':
          description: Successful invocation of `releaseDedicatedCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - releasededicatedclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasededicatedclusterresponse
      x-cloudstack-command: releaseDedicatedCluster
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /releaseDedicatedGuestVlanRange:
    get:
      operationId: releaseDedicatedGuestVlanRange
      summary: Releases a dedicated guest vlan range to the system
      description: |-
        Releases a dedicated guest vlan range to the system

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DedicatedGuestVlanRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseDedicatedGuestVlanRange
          default: releaseDedicatedGuestVlanRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the dedicated guest VLAN range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `releaseDedicatedGuestVlanRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedguestvlanrangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - releasededicatedguestvlanrangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedguestvlanrangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasededicatedguestvlanrangeresponse
      x-cloudstack-command: releaseDedicatedGuestVlanRange
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /releaseDedicatedHost:
    get:
      operationId: releaseDedicatedHost
      summary: Release the dedication for host
      description: |-
        Release the dedication for host

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DedicatedHost
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseDedicatedHost
          default: releaseDedicatedHost
      - $ref: '#/components/parameters/response'
      - name: hostid
        in: query
        description: The ID of the host
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - cancelHostAsDegraded
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `releaseDedicatedHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedhostresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - releasededicatedhostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedhostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasededicatedhostresponse
      x-cloudstack-command: releaseDedicatedHost
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /releaseDedicatedPod:
    get:
      operationId: releaseDedicatedPod
      summary: Release the dedication for the pod
      description: |-
        Release the dedication for the pod

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DedicatedPod
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseDedicatedPod
          default: releaseDedicatedPod
      - $ref: '#/components/parameters/response'
      - name: podid
        in: query
        description: The ID of the Pod
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - listPods
      responses:
        '200':
          description: Successful invocation of `releaseDedicatedPod`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedpodresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - releasededicatedpodresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedpodresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasededicatedpodresponse
      x-cloudstack-command: releaseDedicatedPod
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /releaseDedicatedZone:
    get:
      operationId: releaseDedicatedZone
      summary: Release dedication of zone
      description: |-
        Release dedication of zone

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - DedicatedZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseDedicatedZone
          default: releaseDedicatedZone
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The ID of the Zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `releaseDedicatedZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - releasededicatedzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasededicatedzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasededicatedzoneresponse
      x-cloudstack-command: releaseDedicatedZone
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /releaseHostReservation:
    get:
      operationId: releaseHostReservation
      summary: Releases host reservation.
      description: |-
        Releases host reservation.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - HostReservation
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseHostReservation
          default: releaseHostReservation
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The host ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `releaseHostReservation`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasehostreservationresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - releasehostreservationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasehostreservationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasehostreservationresponse
      x-cloudstack-command: releaseHostReservation
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /releaseIpAddress:
    get:
      operationId: releaseIpAddress
      summary: Releases an IP address from the Account.
      tags:
      - IpAddress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseIpAddress
          default: releaseIpAddress
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the public IP address to release
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      responses:
        '200':
          description: Successful invocation of `releaseIpAddress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releaseipaddressresponse:
                    oneOf:
                    - &id365
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id365
                        - type: array
                          items: *id365
                required:
                - releaseipaddressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releaseipaddressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releaseipaddressresponse
      x-cloudstack-command: releaseIpAddress
      x-cloudstack-async: false
      x-cloudstack-since: '4.17'
  /releaseIpv4SubnetForZone:
    get:
      operationId: releaseIpv4SubnetForZone
      summary: Releases an existing dedicated IPv4 subnet for a zone.
      description: |-
        Releases an existing dedicated IPv4 subnet for a zone.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Ipv4SubnetForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releaseIpv4SubnetForZone
          default: releaseIpv4SubnetForZone
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the guest network IPv4 subnet
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpv4SubnetForZone
        - dedicateIpv4SubnetForZone
        - listIpv4SubnetsForZone
        - releaseIpv4SubnetForZone
      responses:
        '200':
          description: Successful invocation of `releaseIpv4SubnetForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releaseipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - releaseipv4subnetforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releaseipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releaseipv4subnetforzoneresponse
      x-cloudstack-command: releaseIpv4SubnetForZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createIpv4SubnetForZone
      - dedicateIpv4SubnetForZone
      - listIpv4SubnetsForZone
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv4SubnetForZone'
  /releasePodIpAddress:
    get:
      operationId: releasePodIpAddress
      summary: Releases a Pod IP back to the Pod
      tags:
      - IpAddress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releasePodIpAddress
          default: releasePodIpAddress
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: UUID of the Pod IP
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `releasePodIpAddress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasepodipaddressresponse:
                    oneOf:
                    - &id366
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id366
                        - type: array
                          items: *id366
                required:
                - releasepodipaddressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasepodipaddressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasepodipaddressresponse
      x-cloudstack-command: releasePodIpAddress
      x-cloudstack-async: false
  /releasePublicIpRange:
    get:
      operationId: releasePublicIpRange
      summary: Releases a Public IP range back to the system pool
      tags:
      - PublicIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: releasePublicIpRange
          default: releasePublicIpRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Public IP range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVlanIpRange
        - dedicatePublicIpRange
        - updateVlanIpRange
      responses:
        '200':
          description: Successful invocation of `releasePublicIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasepubliciprangeresponse:
                    oneOf:
                    - &id367
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id367
                        - type: array
                          items: *id367
                required:
                - releasepubliciprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  releasepubliciprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - releasepubliciprangeresponse
      x-cloudstack-command: releasePublicIpRange
      x-cloudstack-async: false
  /removeAnnotation:
    get:
      operationId: removeAnnotation
      summary: Remove an annotation.
      tags:
      - Annotation
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeAnnotation
          default: removeAnnotation
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the annotation
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `removeAnnotation`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeannotationresponse:
                    oneOf:
                    - &id368
                      $ref: '#/components/schemas/Annotation'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id368
                        - type: array
                          items: *id368
                required:
                - removeannotationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeannotationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removeannotationresponse
      x-cloudstack-command: removeAnnotation
      x-cloudstack-async: false
      x-cloudstack-since: '4.11'
      x-cloudstack-related:
      - addAnnotation
      - listAnnotations
  /removeCertFromLoadBalancer:
    get:
      operationId: removeCertFromLoadBalancer
      summary: Removes a certificate from a load balancer rule
      description: |-
        Removes a certificate from a load balancer rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeCertFromLoadBalancer
          default: removeCertFromLoadBalancer
      - $ref: '#/components/parameters/response'
      - name: lbruleid
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      responses:
        '200':
          description: Successful invocation of `removeCertFromLoadBalancer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removecertfromloadbalancerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removecertfromloadbalancerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removecertfromloadbalancerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removecertfromloadbalancerresponse
      x-cloudstack-command: removeCertFromLoadBalancer
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /removeFromGlobalLoadBalancerRule:
    get:
      operationId: removeFromGlobalLoadBalancerRule
      summary: Removes a load balancer rule association with global load balancer rule
      description: |-
        Removes a load balancer rule association with global load balancer rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GlobalLoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeFromGlobalLoadBalancerRule
          default: removeFromGlobalLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: loadbalancerrulelist
        in: query
        description: The list load balancer rules that will be assigned to global load balancer rule. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `removeFromGlobalLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removefromgloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removefromgloballoadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removefromgloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removefromgloballoadbalancerruleresponse
      x-cloudstack-command: removeFromGlobalLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /removeFromLoadBalancerRule:
    get:
      operationId: removeFromLoadBalancerRule
      summary: Removes an Instance or a list of  Instances from a load balancer rule.
      description: |-
        Removes an Instance or a list of  Instances from a load balancer rule.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeFromLoadBalancerRule
          default: removeFromLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: virtualmachineids
        in: query
        description: The list of IDs of the Instances that are being removed from the load balancer rule (i.e. virtualMachineIds=1,2,3). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: vmidipmap
        in: query
        description: VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75. Map parameter. CloudStack expects it index-encoded as `vmidipmap[0].key=k&vmidipmap[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `removeFromLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removefromloadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removefromloadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removefromloadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removefromloadbalancerruleresponse
      x-cloudstack-command: removeFromLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /removeGuestOs:
    get:
      operationId: removeGuestOs
      summary: Removes a Guest OS from listing.
      description: |-
        Removes a Guest OS from listing.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GuestO
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeGuestOs
          default: removeGuestOs
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the guest OS
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
      responses:
        '200':
          description: Successful invocation of `removeGuestOs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeguestosresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removeguestosresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeguestosresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removeguestosresponse
      x-cloudstack-command: removeGuestOs
      x-cloudstack-async: true
      x-cloudstack-since: 4.4.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /removeGuestOsMapping:
    get:
      operationId: removeGuestOsMapping
      summary: Removes a Guest OS Mapping.
      description: |-
        Removes a Guest OS Mapping.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GuestOsMapping
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeGuestOsMapping
          default: removeGuestOsMapping
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the guest OS mapping
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOsMapping
        - listGuestOsMapping
        - updateGuestOsMapping
      responses:
        '200':
          description: Successful invocation of `removeGuestOsMapping`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeguestosmappingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removeguestosmappingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeguestosmappingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removeguestosmappingresponse
      x-cloudstack-command: removeGuestOsMapping
      x-cloudstack-async: true
      x-cloudstack-since: 4.4.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /removeGuiTheme:
    get:
      operationId: removeGuiTheme
      summary: Removes an existing GUI theme.
      tags:
      - GuiTheme
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeGuiTheme
          default: removeGuiTheme
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The unique identifier of the GUI theme to be removed.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createGuiTheme
        - listGuiThemes
        - removeGuiTheme
        - updateGuiTheme
      responses:
        '200':
          description: Successful invocation of `removeGuiTheme`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeguithemeresponse:
                    oneOf:
                    - &id369
                      $ref: '#/components/schemas/GuiTheme'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id369
                        - type: array
                          items: *id369
                required:
                - removeguithemeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeguithemeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removeguithemeresponse
      x-cloudstack-command: removeGuiTheme
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0.0
      x-cloudstack-related:
      - createGuiTheme
      - listGuiThemes
      - updateGuiTheme
  /removeIpFromNic:
    get:
      operationId: removeIpFromNic
      summary: Removes secondary IP from the NIC.
      description: |-
        Removes secondary IP from the NIC.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - IpFromNic
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeIpFromNic
          default: removeIpFromNic
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the secondary ip address to NIC
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `removeIpFromNic`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeipfromnicresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removeipfromnicresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeipfromnicresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removeipfromnicresponse
      x-cloudstack-command: removeIpFromNic
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /removeManagementServer:
    get:
      operationId: removeManagementServer
      summary: Removes a Management Server.
      tags:
      - ManagementServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeManagementServer
          default: removeManagementServer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the Management Server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `removeManagementServer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removemanagementserverresponse:
                    oneOf:
                    - &id370
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id370
                        - type: array
                          items: *id370
                required:
                - removemanagementserverresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removemanagementserverresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removemanagementserverresponse
      x-cloudstack-command: removeManagementServer
      x-cloudstack-async: false
  /removeNetworkPermissions:
    get:
      operationId: removeNetworkPermissions
      summary: Removes Network permissions.
      tags:
      - NetworkPermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeNetworkPermissions
          default: removeNetworkPermissions
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: The Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listNetworks
        - updateNetwork
      - name: accountids
        in: query
        description: A comma delimited list of account IDs within owner's domain. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listAccounts
      - name: accounts
        in: query
        description: A comma delimited list of Accounts within owner's domain. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: projectids
        in: query
        description: A comma delimited list of projects within owner's domain. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `removeNetworkPermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removenetworkpermissionsresponse:
                    oneOf:
                    - &id371
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id371
                        - type: array
                          items: *id371
                required:
                - removenetworkpermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removenetworkpermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removenetworkpermissionsresponse
      x-cloudstack-command: removeNetworkPermissions
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /removeNicFromVirtualMachine:
    get:
      operationId: removeNicFromVirtualMachine
      summary: Removes Instance from specified network by deleting a NIC
      description: |-
        Removes Instance from specified network by deleting a NIC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeNicFromVirtualMachine
          default: removeNicFromVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: nicid
        in: query
        description: NIC ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: Instance ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `removeNicFromVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removenicfromvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removenicfromvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removenicfromvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removenicfromvirtualmachineresponse
      x-cloudstack-command: removeNicFromVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /removeNodesFromKubernetesCluster:
    get:
      operationId: removeNodesFromKubernetesCluster
      summary: Removes external nodes from a CKS cluster.
      description: |-
        Removes external nodes from a CKS cluster.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeNodesFromKubernetesCluster
          default: removeNodesFromKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNodesToKubernetesCluster
        - createKubernetesCluster
        - listKubernetesClusters
        - removeNodesFromKubernetesCluster
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
        - upgradeKubernetesCluster
      - name: nodeids
        in: query
        description: comma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
        - updateVmNicIp
      responses:
        '200':
          description: Successful invocation of `removeNodesFromKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removenodesfromkubernetesclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removenodesfromkubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removenodesfromkubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removenodesfromkubernetesclusterresponse
      x-cloudstack-command: removeNodesFromKubernetesCluster
      x-cloudstack-async: true
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - addNodesToKubernetesCluster
      - createKubernetesCluster
      - listKubernetesClusters
      - scaleKubernetesCluster
      - startKubernetesCluster
      - updateKubernetesClusterAffinityGroups
      - upgradeKubernetesCluster
      x-cloudstack-jobresult-schema: '#/components/schemas/KubernetesCluster'
  /removeQuarantinedIp:
    get:
      operationId: removeQuarantinedIp
      summary: Removes a public IP address from quarantine.
      description: Removes a public IP address from quarantine. Only IPs in active quarantine can be removed.
      tags:
      - QuarantinedIp
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeQuarantinedIp
          default: removeQuarantinedIp
      - $ref: '#/components/parameters/response'
      - name: removalreason
        in: query
        description: The reason for removing the public IP address from quarantine prematurely.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: The ID of the public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listQuarantinedIps
        - removeQuarantinedIp
        - updateQuarantinedIp
      - name: ipaddress
        in: query
        description: The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `removeQuarantinedIp`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removequarantinedipresponse:
                    oneOf:
                    - &id372
                      $ref: '#/components/schemas/QuarantinedIp'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id372
                        - type: array
                          items: *id372
                required:
                - removequarantinedipresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removequarantinedipresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removequarantinedipresponse
      x-cloudstack-command: removeQuarantinedIp
      x-cloudstack-async: false
      x-cloudstack-since: '4.19'
      x-cloudstack-related:
      - listQuarantinedIps
      - updateQuarantinedIp
  /removeRawUsageRecords:
    get:
      operationId: removeRawUsageRecords
      summary: Safely removes raw records from cloud_usage table
      tags:
      - RawUsageRecord
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeRawUsageRecords
          default: removeRawUsageRecords
      - $ref: '#/components/parameters/response'
      - name: interval
        in: query
        description: Specify the number of days (greater than zero) to remove records that are older than those number of days from today. For example, specifying 10 would result in removing all the records created before 10 days from today
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `removeRawUsageRecords`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removerawusagerecordsresponse:
                    oneOf:
                    - &id373
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id373
                        - type: array
                          items: *id373
                required:
                - removerawusagerecordsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removerawusagerecordsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removerawusagerecordsresponse
      x-cloudstack-command: removeRawUsageRecords
      x-cloudstack-async: false
      x-cloudstack-since: 4.6.0
  /removeRegion:
    get:
      operationId: removeRegion
      summary: Removes specified region
      tags:
      - Region
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeRegion
          default: removeRegion
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the region to delete
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `removeRegion`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeregionresponse:
                    oneOf:
                    - &id374
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id374
                        - type: array
                          items: *id374
                required:
                - removeregionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeregionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removeregionresponse
      x-cloudstack-command: removeRegion
      x-cloudstack-async: false
  /removeResourceDetail:
    get:
      operationId: removeResourceDetail
      summary: Removes detail for the Resource.
      description: |-
        Removes detail for the Resource.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ResourceDetail
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeResourceDetail
          default: removeResourceDetail
      - $ref: '#/components/parameters/response'
      - name: resourceid
        in: query
        description: Delete details for resource id
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Delete detail by resource type
        required: true
        schema:
          type: string
          maxLength: 255
      - name: key
        in: query
        description: Delete details matching key/value pairs
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `removeResourceDetail`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeresourcedetailresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removeresourcedetailresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removeresourcedetailresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removeresourcedetailresponse
      x-cloudstack-command: removeResourceDetail
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /removeSecondaryStorageSelector:
    get:
      operationId: removeSecondaryStorageSelector
      summary: Removes an existing secondary storage selector.
      tags:
      - SecondaryStorageSelector
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeSecondaryStorageSelector
          default: removeSecondaryStorageSelector
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The unique identifier of the secondary storage selector to be removed.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `removeSecondaryStorageSelector`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removesecondarystorageselectorresponse:
                    oneOf:
                    - &id375
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id375
                        - type: array
                          items: *id375
                required:
                - removesecondarystorageselectorresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removesecondarystorageselectorresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removesecondarystorageselectorresponse
      x-cloudstack-command: removeSecondaryStorageSelector
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /removeTungstenFabricNetworkGatewayFromLogicalRouter:
    get:
      operationId: removeTungstenFabricNetworkGatewayFromLogicalRouter
      summary: Remove Tungsten-Fabric network gateway from logical router
      description: |-
        Remove Tungsten-Fabric network gateway from logical router

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Router
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeTungstenFabricNetworkGatewayFromLogicalRouter
          default: removeTungstenFabricNetworkGatewayFromLogicalRouter
      - $ref: '#/components/parameters/response'
      - name: logicalrouteruuid
        in: query
        description: Tungsten-Fabric logical router uuid
        required: true
        schema:
          type: string
          maxLength: 255
      - name: networkuuid
        in: query
        description: Tungsten-Fabric network uuid
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `removeTungstenFabricNetworkGatewayFromLogicalRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removetungstenfabricnetworkgatewayfromlogicalrouterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removetungstenfabricnetworkgatewayfromlogicalrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removetungstenfabricnetworkgatewayfromlogicalrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removetungstenfabricnetworkgatewayfromlogicalrouterresponse
      x-cloudstack-command: removeTungstenFabricNetworkGatewayFromLogicalRouter
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricPolicy'
  /removeTungstenFabricPolicy:
    get:
      operationId: removeTungstenFabricPolicy
      summary: Remove Tungsten-Fabric policy
      description: |-
        Remove Tungsten-Fabric policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeTungstenFabricPolicy
          default: removeTungstenFabricPolicy
      - $ref: '#/components/parameters/response'
      - name: networkuuid
        in: query
        description: The uuid of Tungsten-Fabric network
        required: true
        schema:
          type: string
          maxLength: 255
      - name: policyuuid
        in: query
        description: The uuid of Tungsten-Fabric policy
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `removeTungstenFabricPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removetungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removetungstenfabricpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removetungstenfabricpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removetungstenfabricpolicyresponse
      x-cloudstack-command: removeTungstenFabricPolicy
      x-cloudstack-async: true
      x-cloudstack-related:
      - applyTungstenFabricPolicy
      - createTungstenFabricPolicy
      - listTungstenFabricPolicy
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricPolicy'
  /removeTungstenFabricPolicyRule:
    get:
      operationId: removeTungstenFabricPolicyRule
      summary: Remove Tungsten-Fabric policy
      description: |-
        Remove Tungsten-Fabric policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricPolicyRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeTungstenFabricPolicyRule
          default: removeTungstenFabricPolicyRule
      - $ref: '#/components/parameters/response'
      - name: policyuuid
        in: query
        description: The Uuid of Tungsten-Fabric policy
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ruleuuid
        in: query
        description: The Uuid of Tungsten-Fabric policy rule
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `removeTungstenFabricPolicyRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removetungstenfabricpolicyruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removetungstenfabricpolicyruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removetungstenfabricpolicyruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removetungstenfabricpolicyruleresponse
      x-cloudstack-command: removeTungstenFabricPolicyRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - applyTungstenFabricPolicy
      - createTungstenFabricPolicy
      - listTungstenFabricPolicy
      - removeTungstenFabricPolicy
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricPolicy'
  /removeTungstenFabricTag:
    get:
      operationId: removeTungstenFabricTag
      summary: Remove Tungsten-Fabric tag
      description: |-
        Remove Tungsten-Fabric tag

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricTag
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeTungstenFabricTag
          default: removeTungstenFabricTag
      - $ref: '#/components/parameters/response'
      - name: taguuid
        in: query
        description: The UUID of Tungsten-Fabric tag
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of Zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      - name: applicationpolicysetuuid
        in: query
        description: The UUID of Tungsten-Fabric application policy set
        schema:
          type: string
          maxLength: 255
      - name: networkuuid
        in: query
        description: The UUID of Networks. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: nicuuid
        in: query
        description: The UUID of NICs. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: policyuuid
        in: query
        description: The UUID of Tungsten-Fabric policy
        schema:
          type: string
          maxLength: 255
      - name: vmuuid
        in: query
        description: The UUID of Instances. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `removeTungstenFabricTag`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removetungstenfabrictagresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removetungstenfabrictagresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removetungstenfabrictagresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removetungstenfabrictagresponse
      x-cloudstack-command: removeTungstenFabricTag
      x-cloudstack-async: true
      x-cloudstack-related:
      - applyTungstenFabricTag
      - createTungstenFabricTag
      - listTungstenFabricTag
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricTag'
  /removeVirtualMachineFromBackupOffering:
    get:
      operationId: removeVirtualMachineFromBackupOffering
      summary: Removes an Instance from any existing backup offering
      description: |-
        Removes an Instance from any existing backup offering

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BackupOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeVirtualMachineFromBackupOffering
          default: removeVirtualMachineFromBackupOffering
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: ID of the  Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: forced
        in: query
        description: Whether to force remove Instance from the backup offering that may also delete Instance backups.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `removeVirtualMachineFromBackupOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removevirtualmachinefrombackupofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removevirtualmachinefrombackupofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removevirtualmachinefrombackupofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removevirtualmachinefrombackupofferingresponse
      x-cloudstack-command: removeVirtualMachineFromBackupOffering
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /removeVirtualMachinesFromKubernetesCluster:
    get:
      operationId: removeVirtualMachinesFromKubernetesCluster
      summary: Remove VMs from an ExternalManaged kubernetes cluster.
      description: Remove VMs from an ExternalManaged kubernetes cluster. Not applicable for CloudManaged kubernetes clusters.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeVirtualMachinesFromKubernetesCluster
          default: removeVirtualMachinesFromKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKubernetesCluster
        - listKubernetesClusters
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
        - upgradeKubernetesCluster
      - name: virtualmachineids
        in: query
        description: The IDs of the VMs to remove from the cluster. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `removeVirtualMachinesFromKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removevirtualmachinesfromkubernetesclusterresponse:
                    oneOf:
                    - &id376
                      $ref: '#/components/schemas/VirtualMachinesFromKubernetesCluster'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id376
                        - type: array
                          items: *id376
                required:
                - removevirtualmachinesfromkubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removevirtualmachinesfromkubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removevirtualmachinesfromkubernetesclusterresponse
      x-cloudstack-command: removeVirtualMachinesFromKubernetesCluster
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /removeVmwareDc:
    get:
      operationId: removeVmwareDc
      summary: Remove a VMware datacenter from a zone.
      tags:
      - VmwareDc
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeVmwareDc
          default: removeVmwareDc
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The id of Zone from which VMware datacenter has to be removed.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `removeVmwareDc`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removevmwaredcresponse:
                    oneOf:
                    - &id377
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id377
                        - type: array
                          items: *id377
                required:
                - removevmwaredcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removevmwaredcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removevmwaredcresponse
      x-cloudstack-command: removeVmwareDc
      x-cloudstack-async: false
  /removeVpnUser:
    get:
      operationId: removeVpnUser
      summary: Removes VPN User
      description: |-
        Removes VPN User

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnUser
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: removeVpnUser
          default: removeVpnUser
      - $ref: '#/components/parameters/response'
      - name: username
        in: query
        description: Username for the VPN User
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: An optional Account for the VPN User. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the VPN User. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: projectid
        in: query
        description: Remove VPN User from the project
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `removeVpnUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removevpnuserresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - removevpnuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  removevpnuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - removevpnuserresponse
      x-cloudstack-command: removeVpnUser
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /replaceNetworkACLList:
    get:
      operationId: replaceNetworkACLList
      summary: Replaces ACL associated with a network or private gateway
      description: |-
        Replaces ACL associated with a network or private gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkACLList
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: replaceNetworkACLList
          default: replaceNetworkACLList
      - $ref: '#/components/parameters/response'
      - name: aclid
        in: query
        description: The ID of the network ACL
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
        - listNetworkACLLists
      - name: gatewayid
        in: query
        description: The ID of the private gateway
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createPrivateGateway
        - listPrivateGateways
      - name: networkid
        in: query
        description: The ID of the network
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      responses:
        '200':
          description: Successful invocation of `replaceNetworkACLList`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  replacenetworkacllistresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - replacenetworkacllistresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  replacenetworkacllistresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - replacenetworkacllistresponse
      x-cloudstack-command: replaceNetworkACLList
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /reserveIpAddress:
    get:
      operationId: reserveIpAddress
      summary: Reserve a public IP to an Account.
      tags:
      - IpAddress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: reserveIpAddress
          default: reserveIpAddress
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the public IP address to reserve
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - reserveIpAddress
        - updateIpAddress
      - name: account
        in: query
        description: The Account to reserve with this IP address
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the domain to reserve with this IP address
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the IP to the end User or not
        schema:
          type: boolean
      - name: projectid
        in: query
        description: The ID of the project to reserve with this IP address
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `reserveIpAddress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  reserveipaddressresponse:
                    oneOf:
                    - &id378
                      $ref: '#/components/schemas/IpAddress'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id378
                        - type: array
                          items: *id378
                required:
                - reserveipaddressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  reserveipaddressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - reserveipaddressresponse
      x-cloudstack-command: reserveIpAddress
      x-cloudstack-async: false
      x-cloudstack-since: '4.17'
      x-cloudstack-related:
      - associateIpAddress
      - listPublicIpAddresses
      - updateIpAddress
  /resetApiLimit:
    get:
      operationId: resetApiLimit
      summary: Reset api count
      tags:
      - ApiLimit
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: resetApiLimit
          default: resetApiLimit
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: The ID of the Account whose limit to be reset
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      responses:
        '200':
          description: Successful invocation of `resetApiLimit`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetapilimitresponse:
                    oneOf:
                    - &id379
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id379
                        - type: array
                          items: *id379
                required:
                - resetapilimitresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetapilimitresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - resetapilimitresponse
      x-cloudstack-command: resetApiLimit
      x-cloudstack-async: false
  /resetConfiguration:
    get:
      operationId: resetConfiguration
      summary: Resets a configuration.
      description: Resets a configuration. The configuration will be set to default value for global setting, and removed from account_details or domain_details for Account/Domain settings
      tags:
      - Configuration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: resetConfiguration
          default: resetConfiguration
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the configuration
        required: true
        schema:
          type: string
          maxLength: 255
      - name: accountid
        in: query
        description: The ID of the Account to reset the parameter value for corresponding account
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createAccount
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      - name: clusterid
        in: query
        description: The ID of the Cluster to reset the parameter value for corresponding cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: domainid
        in: query
        description: The ID of the Domain to reset the parameter value for corresponding domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: imagestoreid
        in: query
        description: The ID of the Image Store to reset the parameter value for corresponding image store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addImageStoreS3
        - addSecondaryStorage
        - addSwift
        - createSecondaryStagingStore
        - listImageStores
        - listSwifts
        - updateCloudToUseObjectStore
        - updateImageStore
      - name: managementserverid
        in: query
        description: the ID of the Management Server to update the parameter value for corresponding management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - listManagementServers
      - name: storageid
        in: query
        description: The ID of the Storage pool to reset the parameter value for corresponding storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - listStoragePools
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: zoneid
        in: query
        description: The ID of the Zone to reset the parameter value for corresponding zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `resetConfiguration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetconfigurationresponse:
                    oneOf:
                    - &id380
                      $ref: '#/components/schemas/Configuration'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id380
                        - type: array
                          items: *id380
                required:
                - resetconfigurationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetconfigurationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - resetconfigurationresponse
      x-cloudstack-command: resetConfiguration
      x-cloudstack-async: false
      x-cloudstack-since: 4.16.0
      x-cloudstack-related:
      - listConfigurations
      - updateConfiguration
  /resetNetworkPermissions:
    get:
      operationId: resetNetworkPermissions
      summary: Resets Network permissions.
      tags:
      - NetworkPermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: resetNetworkPermissions
          default: resetNetworkPermissions
      - $ref: '#/components/parameters/response'
      - name: networkid
        in: query
        description: The Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      responses:
        '200':
          description: Successful invocation of `resetNetworkPermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetnetworkpermissionsresponse:
                    oneOf:
                    - &id381
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id381
                        - type: array
                          items: *id381
                required:
                - resetnetworkpermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetnetworkpermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - resetnetworkpermissionsresponse
      x-cloudstack-command: resetNetworkPermissions
      x-cloudstack-async: false
      x-cloudstack-since: 4.17.0
  /resetPasswordForVirtualMachine:
    get:
      operationId: resetPasswordForVirtualMachine
      summary: Resets the password for Instance.
      description: |-
        Resets the password for Instance. The Instance must be in a "Stopped" state and the Template must already support this feature for this command to take effect. [async]

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: resetPasswordForVirtualMachine
          default: resetPasswordForVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: password
        in: query
        description: The new password of the virtual machine. If null, a random password will be generated for the VM.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      responses:
        '200':
          description: Successful invocation of `resetPasswordForVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetpasswordforvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - resetpasswordforvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetpasswordforvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - resetpasswordforvirtualmachineresponse
      x-cloudstack-command: resetPasswordForVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /resetSSHKeyForVirtualMachine:
    get:
      operationId: resetSSHKeyForVirtualMachine
      summary: Resets the SSH Key for Instance.
      description: |-
        Resets the SSH Key for Instance. The Instance must be in a "Stopped" state. [async]

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: resetSSHKeyForVirtualMachine
          default: resetSSHKeyForVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: account
        in: query
        description: An optional Account for the SSH key. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the Instance. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: keypair
        in: query
        description: Name of the SSH key pair used to login to the Instance
        schema:
          type: string
          maxLength: 255
      - name: keypairs
        in: query
        description: Names of the SSH key pairs to be used to login to the Instance. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.17'
      - name: projectid
        in: query
        description: An optional project for the SSH key
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `resetSSHKeyForVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetsshkeyforvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - resetsshkeyforvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetsshkeyforvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - resetsshkeyforvirtualmachineresponse
      x-cloudstack-command: resetSSHKeyForVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /resetUserDataForVirtualMachine:
    get:
      operationId: resetUserDataForVirtualMachine
      summary: Resets the UserData for Instance.
      description: Resets the UserData for Instance. The Instance must be in a "Stopped" state.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: resetUserDataForVirtualMachine
          default: resetUserDataForVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: account
        in: query
        description: An optional Account for the Instance. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for the Instance. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: projectid
        in: query
        description: An optional project for the Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: userdata
        in: query
        description: An optional binary data that can be sent to the Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value
        schema:
          type: string
          maxLength: 1048576
      - name: userdatadetails
        in: query
        description: Used to specify the parameters values for the variables in userdata. Map parameter. CloudStack expects it index-encoded as `userdatadetails[0].key=k&userdatadetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: userdataid
        in: query
        description: The ID of the userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `resetUserDataForVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetuserdataforvirtualmachineresponse:
                    oneOf:
                    - &id382
                      $ref: '#/components/schemas/VirtualMachine'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id382
                        - type: array
                          items: *id382
                required:
                - resetuserdataforvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetuserdataforvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - resetuserdataforvirtualmachineresponse
      x-cloudstack-command: resetUserDataForVirtualMachine
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
  /resetVpnConnection:
    get:
      operationId: resetVpnConnection
      summary: Reset site to site VPN connection
      description: |-
        Reset site to site VPN connection

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnConnection
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: resetVpnConnection
          default: resetVpnConnection
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of VPN connection
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVpnConnection
        - listVpnConnections
        - resetVpnConnection
        - updateVpnConnection
      - name: account
        in: query
        description: An optional Account for connection. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId for connection. If the Account parameter is used, domainId must also be used.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      responses:
        '200':
          description: Successful invocation of `resetVpnConnection`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetvpnconnectionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - resetvpnconnectionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resetvpnconnectionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - resetvpnconnectionresponse
      x-cloudstack-command: resetVpnConnection
      x-cloudstack-async: true
      x-cloudstack-related:
      - createVpnConnection
      - listVpnConnections
      - updateVpnConnection
      x-cloudstack-jobresult-schema: '#/components/schemas/VpnConnection'
  /resizeVolume:
    get:
      operationId: resizeVolume
      summary: Resizes a volume
      description: |-
        Resizes a volume

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: resizeVolume
          default: resizeVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the disk volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: automigrate
        in: query
        description: Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size
        schema:
          type: boolean
        x-cloudstack-since: 4.20.1
      - name: diskofferingid
        in: query
        description: New disk offering ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
        - listDiskOfferings
      - name: maxiops
        in: query
        description: New maximum number of IOPS
        schema:
          type: integer
          format: int64
      - name: miniops
        in: query
        description: New minimum number of IOPS
        schema:
          type: integer
          format: int64
      - name: shrinkok
        in: query
        description: Verify OK to Shrink
        schema:
          type: boolean
      - name: size
        in: query
        description: New volume size in GB
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `resizeVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resizevolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - resizevolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  resizevolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - resizevolumeresponse
      x-cloudstack-command: resizeVolume
      x-cloudstack-async: true
      x-cloudstack-related:
      - assignVolume
      - attachVolume
      - changeOfferingForVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /restartNetwork:
    get:
      operationId: restartNetwork
      summary: Restarts the Network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules
      description: |-
        Restarts the Network; includes 1) restarting network elements - virtual routers, DHCP servers 2) reapplying all public IPs 3) reapplying loadBalancing/portForwarding rules

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: restartNetwork
          default: restartNetwork
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network to restart.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listNiciraNvpDeviceNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: cleanup
        in: query
        description: If cleanup old network elements
        schema:
          type: boolean
      - name: livepatch
        in: query
        description: Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.
        schema:
          type: boolean
        x-cloudstack-since: 4.17.0
      - name: makeredundant
        in: query
        description: Turn the network into a network with redundant routers.
        schema:
          type: boolean
        x-cloudstack-since: 4.11.1
      responses:
        '200':
          description: Successful invocation of `restartNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restartnetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - restartnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restartnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - restartnetworkresponse
      x-cloudstack-command: restartNetwork
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /restartSharedFileSystem:
    get:
      operationId: restartSharedFileSystem
      summary: Restart a Shared FileSystem
      description: |-
        Restart a Shared FileSystem

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: restartSharedFileSystem
          default: restartSharedFileSystem
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the shared filesystem
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
        - changeSharedFileSystemServiceOffering
        - listSharedFileSystems
        - startSharedFileSystem
        - stopSharedFileSystem
      - name: cleanup
        in: query
        description: is cleanup required
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `restartSharedFileSystem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restartsharedfilesystemresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - restartsharedfilesystemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restartsharedfilesystemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - restartsharedfilesystemresponse
      x-cloudstack-command: restartSharedFileSystem
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /restartVPC:
    get:
      operationId: restartVPC
      summary: Restarts a VPC
      description: |-
        Restarts a VPC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPC
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: restartVPC
          default: restartVPC
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the VPC
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - updateVPC
      - name: cleanup
        in: query
        description: Should we cleanup the old Network elements
        schema:
          type: boolean
      - name: livepatch
        in: query
        description: Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.
        schema:
          type: boolean
        x-cloudstack-since: 4.17.0
      - name: makeredundant
        in: query
        description: Turn a single VPC into a redundant one.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `restartVPC`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restartvpcresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - restartvpcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restartvpcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - restartvpcresponse
      x-cloudstack-command: restartVPC
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /restoreBackup:
    get:
      operationId: restoreBackup
      summary: Restores an existing stopped or deleted Instance using an Instance backup
      description: |-
        Restores an existing stopped or deleted Instance using an Instance backup

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Backup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: restoreBackup
          default: restoreBackup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the backup
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: hostid
        in: query
        description: If quickrestore is true, which host to start the VM on; otherwise, ignored. Currently this parameter is only supported by the KBOSS provider.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: quickrestore
        in: query
        description: Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      responses:
        '200':
          description: Successful invocation of `restoreBackup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restorebackupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - restorebackupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restorebackupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - restorebackupresponse
      x-cloudstack-command: restoreBackup
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /restoreVirtualMachine:
    get:
      operationId: restoreVirtualMachine
      summary: Restore an Instance to original Template/ISO or new Template/ISO
      description: |-
        Restore an Instance to original Template/ISO or new Template/ISO

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: restoreVirtualMachine
          default: restoreVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: virtualmachineid
        in: query
        description: Instance ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
        - updateVmNicIp
      - name: details
        in: query
        description: used to specify the custom parameters. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.19.1
      - name: diskofferingid
        in: query
        description: Override root volume's diskoffering.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.19.1
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
        - listDiskOfferings
        - updateDiskOffering
      - name: expunge
        in: query
        description: Optional field to expunge old root volume after restore.
        schema:
          type: boolean
        x-cloudstack-since: 4.19.1
      - name: rootdisksize
        in: query
        description: Override root volume's size (in GB). Analogous to details[0].rootdisksize, which takes precedence over this parameter if both are provided
        schema:
          type: integer
          format: int64
        x-cloudstack-since: 4.19.1
      - name: templateid
        in: query
        description: An optional Template Id to restore Instance from the new Template. This can be an ISO id in case of restore Instance deployed using ISO
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      responses:
        '200':
          description: Successful invocation of `restoreVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restorevirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - restorevirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restorevirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - restorevirtualmachineresponse
      x-cloudstack-command: restoreVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachine
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      - updateVmNicIp
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /restoreVolumeFromBackupAndAttachToVM:
    get:
      operationId: restoreVolumeFromBackupAndAttachToVM
      summary: Restore and attach a backed up volume to Instance
      description: |-
        Restore and attach a backed up volume to Instance

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VolumeFromBackupAndAttachToVM
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: restoreVolumeFromBackupAndAttachToVM
          default: restoreVolumeFromBackupAndAttachToVM
      - $ref: '#/components/parameters/response'
      - name: backupid
        in: query
        description: ID of the Instance backup
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: ID of the Instance where to attach the restored volume
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: volumeid
        in: query
        description: ID of the volume backed up
        required: true
        schema:
          type: string
          maxLength: 255
      - name: hostid
        in: query
        description: If quickrestore is true, which host to start the VM on; otherwise, ignored. Currently this parameter is only supported by the KBOSS provider.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: quickrestore
        in: query
        description: Whether to use the quick restore process or not. Currently this parameter is only supported by the KBOSS provider.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      responses:
        '200':
          description: Successful invocation of `restoreVolumeFromBackupAndAttachToVM`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restorevolumefrombackupandattachtovmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - restorevolumefrombackupandattachtovmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  restorevolumefrombackupandattachtovmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - restorevolumefrombackupandattachtovmresponse
      x-cloudstack-command: restoreVolumeFromBackupAndAttachToVM
      x-cloudstack-async: true
      x-cloudstack-since: 4.14.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /revertSnapshot:
    get:
      operationId: revertSnapshot
      summary: This is supposed to revert a volume Snapshot.
      description: |-
        This is supposed to revert a volume Snapshot. This command is only supported with KVM so far

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Snapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: revertSnapshot
          default: revertSnapshot
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Snapshot
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - archiveSnapshot
        - copySnapshot
        - createSnapshotFromVMSnapshot
        - listSnapshots
        - revertSnapshot
      responses:
        '200':
          description: Successful invocation of `revertSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revertsnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - revertsnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revertsnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - revertsnapshotresponse
      x-cloudstack-command: revertSnapshot
      x-cloudstack-async: true
      x-cloudstack-related:
      - archiveSnapshot
      - copySnapshot
      - createSnapshotFromVMSnapshot
      - listSnapshots
      x-cloudstack-jobresult-schema: '#/components/schemas/Snapshot'
  /revertToVMSnapshot:
    get:
      operationId: revertToVMSnapshot
      summary: Revert Instance from a vmsnapshot.
      description: |-
        Revert Instance from a vmsnapshot.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VMSnapshot
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: revertToVMSnapshot
          default: revertToVMSnapshot
      - $ref: '#/components/parameters/response'
      - name: vmsnapshotid
        in: query
        description: The ID of the Instance Snapshot
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVMSnapshot
        - listVMSnapshot
      responses:
        '200':
          description: Successful invocation of `revertToVMSnapshot`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  reverttovmsnapshotresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - reverttovmsnapshotresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  reverttovmsnapshotresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - reverttovmsnapshotresponse
      x-cloudstack-command: revertToVMSnapshot
      x-cloudstack-async: true
      x-cloudstack-since: 4.2.0
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /revokeCertificate:
    get:
      operationId: revokeCertificate
      summary: Revokes certificate using configured CA plugin
      description: |-
        Revokes certificate using configured CA plugin

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Certificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: revokeCertificate
          default: revokeCertificate
      - $ref: '#/components/parameters/response'
      - name: serial
        in: query
        description: The certificate serial number, as a hex value
        required: true
        schema:
          type: string
          maxLength: 255
      - name: cn
        in: query
        description: The certificate CN
        schema:
          type: string
          maxLength: 255
      - name: provider
        in: query
        description: Name of the CA service provider, otherwise the default configured provider plugin will be used
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `revokeCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revokecertificateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - revokecertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revokecertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - revokecertificateresponse
      x-cloudstack-command: revokeCertificate
      x-cloudstack-async: true
      x-cloudstack-since: 4.11.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /revokeSecurityGroupEgress:
    get:
      operationId: revokeSecurityGroupEgress
      summary: Deletes a particular egress rule from this security group
      description: |-
        Deletes a particular egress rule from this security group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SecurityGroupEgress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: revokeSecurityGroupEgress
          default: revokeSecurityGroupEgress
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the egress rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - authorizeSecurityGroupIngress
      responses:
        '200':
          description: Successful invocation of `revokeSecurityGroupEgress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revokesecuritygroupegressresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - revokesecuritygroupegressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revokesecuritygroupegressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - revokesecuritygroupegressresponse
      x-cloudstack-command: revokeSecurityGroupEgress
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /revokeSecurityGroupIngress:
    get:
      operationId: revokeSecurityGroupIngress
      summary: Deletes a particular ingress rule from this security group
      description: |-
        Deletes a particular ingress rule from this security group

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SecurityGroupIngress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: revokeSecurityGroupIngress
          default: revokeSecurityGroupIngress
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the ingress rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - authorizeSecurityGroupIngress
      responses:
        '200':
          description: Successful invocation of `revokeSecurityGroupIngress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revokesecuritygroupingressresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - revokesecuritygroupingressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revokesecuritygroupingressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - revokesecuritygroupingressresponse
      x-cloudstack-command: revokeSecurityGroupIngress
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /revokeTemplateDirectDownloadCertificate:
    get:
      operationId: revokeTemplateDirectDownloadCertificate
      summary: Revoke a direct download certificate from hosts in a zone
      tags:
      - TemplateDirectDownloadCertificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: revokeTemplateDirectDownloadCertificate
          default: revokeTemplateDirectDownloadCertificate
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: (Optional) zone to revoke certificate
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: hostid
        in: query
        description: (Optional) the host ID to revoke certificate
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: hypervisor
        in: query
        description: (Optional) hypervisor type
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: ID of the certificate
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listTemplateDirectDownloadCertificates
      - name: name
        in: query
        description: (Optional) alias of the SSL certificate
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `revokeTemplateDirectDownloadCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revoketemplatedirectdownloadcertificateresponse:
                    oneOf:
                    - &id383
                      $ref: '#/components/schemas/TemplateDirectDownloadCertificate2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id383
                        - type: array
                          items: *id383
                required:
                - revoketemplatedirectdownloadcertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  revoketemplatedirectdownloadcertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - revoketemplatedirectdownloadcertificateresponse
      x-cloudstack-command: revokeTemplateDirectDownloadCertificate
      x-cloudstack-async: false
      x-cloudstack-since: '4.13'
      x-cloudstack-related:
      - provisionTemplateDirectDownloadCertificate
  /rotateKMSKey:
    get:
      operationId: rotateKMSKey
      summary: Rotates KMS key (KEK) by creating new version and scheduling gradual re-encryption
      description: |-
        Rotates KMS key (KEK) by creating new version and scheduling gradual re-encryption

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KMSKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: rotateKMSKey
          default: rotateKMSKey
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: KMS Key UUID to rotate
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKMSKey
        - updateKMSKey
      - name: hsmprofileid
        in: query
        description: The target HSM profile ID for the new KEK version. If provided, migrates the key to this HSM.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: keybits
        in: query
        description: 'Key size for new KEK (default: same as current)'
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `rotateKMSKey`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rotatekmskeyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - rotatekmskeyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rotatekmskeyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - rotatekmskeyresponse
      x-cloudstack-command: rotateKMSKey
      x-cloudstack-async: true
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - queryAsyncJobResult
      x-cloudstack-jobresult-schema: '#/components/schemas/ListAsyncJobsResult'
  /runCustomAction:
    get:
      operationId: runCustomAction
      summary: Run the custom action
      description: |-
        Run the custom action

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - CustomAction
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: runCustomAction
          default: runCustomAction
      - $ref: '#/components/parameters/response'
      - name: customactionid
        in: query
        description: ID of the custom action
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCustomAction
        - listCustomActions
      - name: resourceid
        in: query
        description: ID of the instance
        required: true
        schema:
          type: string
          maxLength: 255
      - name: parameters
        in: query
        description: 'Parameters in key/value pairs using format parameters[i].keyname=keyvalue. Example: parameters[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `parameters[0].key=k&parameters[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: resourcetype
        in: query
        description: Type of the resource
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `runCustomAction`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  runcustomactionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - runcustomactionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  runcustomactionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - runcustomactionresponse
      x-cloudstack-command: runCustomAction
      x-cloudstack-async: true
      x-cloudstack-since: 4.21.0
      x-cloudstack-jobresult-schema: '#/components/schemas/CustomAction2'
  /runDiagnostics:
    get:
      operationId: runDiagnostics
      summary: Execute network-utility command (ping/arping/tracert) on System VMs remotely
      description: |-
        Execute network-utility command (ping/arping/tracert) on System VMs remotely

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Diagnostic
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: runDiagnostics
          default: runDiagnostics
      - $ref: '#/components/parameters/response'
      - name: ipaddress
        in: query
        description: The IP/Domain address to test connection to
        required: true
        schema:
          type: string
          maxLength: 255
      - name: targetid
        in: query
        description: The ID of the System VM to diagnose
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - startSystemVm
      - name: type
        in: query
        description: 'The System VM diagnostics type valid options are: ping, traceroute, arping'
        required: true
        schema:
          type: string
          maxLength: 255
      - name: params
        in: query
        description: Additional command line options that apply for each command
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `runDiagnostics`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rundiagnosticsresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - rundiagnosticsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  rundiagnosticsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - rundiagnosticsresponse
      x-cloudstack-command: runDiagnostics
      x-cloudstack-async: true
      x-cloudstack-since: 4.12.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/Diagnostic'
  /scaleKubernetesCluster:
    get:
      operationId: scaleKubernetesCluster
      summary: Scales a created, running or stopped CloudManaged Kubernetes cluster
      description: |-
        Scales a created, running or stopped CloudManaged Kubernetes cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: scaleKubernetesCluster
          default: scaleKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKubernetesCluster
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
      - name: autoscalingenabled
        in: query
        description: Whether autoscaling is enabled for the cluster
        schema:
          type: boolean
      - name: maxsize
        in: query
        description: Maximum number of worker nodes in the cluster
        schema:
          type: integer
          format: int64
      - name: minsize
        in: query
        description: Minimum number of worker nodes in the cluster
        schema:
          type: integer
          format: int64
      - name: nodeids
        in: query
        description: The IDs of the nodes to be removed. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: nodeofferings
        in: query
        description: (Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter. Map parameter. CloudStack expects it index-encoded as `nodeofferings[0].key=k&nodeofferings[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: serviceofferingid
        in: query
        description: The ID of the service offering for the virtual machines in the cluster.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: size
        in: query
        description: Number of Kubernetes cluster nodes
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `scaleKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scalekubernetesclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - scalekubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scalekubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - scalekubernetesclusterresponse
      x-cloudstack-command: scaleKubernetesCluster
      x-cloudstack-async: true
      x-cloudstack-related:
      - createKubernetesCluster
      - startKubernetesCluster
      - updateKubernetesClusterAffinityGroups
      x-cloudstack-jobresult-schema: '#/components/schemas/KubernetesCluster'
  /scaleSystemVm:
    get:
      operationId: scaleSystemVm
      summary: Scale the service offering for a system vm (console proxy or secondary storage).
      description: |-
        Scale the service offering for a system vm (console proxy or secondary storage). The system vm must be in a "Stopped" state for this command to take effect.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: scaleSystemVm
          default: scaleSystemVm
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the system vm
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForSystemVm
        - listSystemVms
        - migrateSystemVm
        - scaleSystemVm
        - startSystemVm
        - stopSystemVm
      - name: serviceofferingid
        in: query
        description: The service offering ID to apply to the system vm
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneServiceOffering
        - createServiceOffering
        - listServiceOfferings
        - updateServiceOffering
      - name: details
        in: query
        description: Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `scaleSystemVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scalesystemvmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - scalesystemvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scalesystemvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - scalesystemvmresponse
      x-cloudstack-command: scaleSystemVm
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForSystemVm
      - listSystemVms
      - migrateSystemVm
      - startSystemVm
      - stopSystemVm
      x-cloudstack-jobresult-schema: '#/components/schemas/SystemVm'
  /scaleVirtualMachine:
    get:
      operationId: scaleVirtualMachine
      summary: Scales the Instance to a new service offering.
      description: |-
        Scales the Instance to a new service offering. This command also considers the volume size in the service offering or disk offering linked to the new service offering and apply all characteristics to the root volume.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: scaleVirtualMachine
          default: scaleVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the  Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: serviceofferingid
        in: query
        description: The ID of the service offering for the  Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: automigrate
        in: query
        description: Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering
        schema:
          type: boolean
        x-cloudstack-since: '4.17'
      - name: details
        in: query
        description: Name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: maxiops
        in: query
        description: New maximum number of IOPS for the custom disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.17'
      - name: miniops
        in: query
        description: New minimum number of IOPS for the custom disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.17'
      - name: shrinkok
        in: query
        description: Verify OK to Shrink
        schema:
          type: boolean
        x-cloudstack-since: '4.17'
      responses:
        '200':
          description: Successful invocation of `scaleVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scalevirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - scalevirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scalevirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - scalevirtualmachineresponse
      x-cloudstack-command: scaleVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /searchLdap:
    get:
      operationId: searchLdap
      summary: Searches LDAP based on the username attribute
      tags:
      - SearchLdap
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: searchLdap
          default: searchLdap
      - $ref: '#/components/parameters/response'
      - name: query
        in: query
        description: Query to search using
        required: true
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - searchLdap
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `searchLdap`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  searchldapresponse:
                    oneOf:
                    - &id384
                      $ref: '#/components/schemas/LdapUser'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id384
                        - type: array
                          items: *id384
                required:
                - searchldapresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  searchldapresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - searchldapresponse
      x-cloudstack-command: searchLdap
      x-cloudstack-async: false
      x-cloudstack-since: 4.2.0
  /setupUserTwoFactorAuthentication:
    get:
      operationId: setupUserTwoFactorAuthentication
      summary: Setup the 2FA for the user.
      tags:
      - SetupUserTwoFactorAuthentication
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: setupUserTwoFactorAuthentication
          default: setupUserTwoFactorAuthentication
      - $ref: '#/components/parameters/response'
      - name: enable
        in: query
        description: Enabled by default, provide false to disable 2FA
        schema:
          type: boolean
      - name: provider
        in: query
        description: Two factor authentication code
        schema:
          type: string
          maxLength: 255
      - name: userid
        in: query
        description: 'Optional: the id of the User for which 2FA has to be disabled'
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
        - updateUser
      responses:
        '200':
          description: Successful invocation of `setupUserTwoFactorAuthentication`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  setupusertwofactorauthenticationresponse:
                    oneOf:
                    - &id385
                      $ref: '#/components/schemas/SetupUserTwoFactorAuthentication'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id385
                        - type: array
                          items: *id385
                required:
                - setupusertwofactorauthenticationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  setupusertwofactorauthenticationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - setupusertwofactorauthenticationresponse
      x-cloudstack-command: setupUserTwoFactorAuthentication
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
  /startInternalLoadBalancerVM:
    get:
      operationId: startInternalLoadBalancerVM
      summary: Starts an existing Internal LB Instance.
      description: |-
        Starts an existing Internal LB Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - InternalLoadBalancerVM
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: startInternalLoadBalancerVM
          default: startInternalLoadBalancerVM
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Internal LB Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - destroyRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - rebootRouter
        - startInternalLoadBalancerVM
        - stopInternalLoadBalancerVM
        - stopNetScalerVpx
        - stopRouter
      responses:
        '200':
          description: Successful invocation of `startInternalLoadBalancerVM`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startinternalloadbalancervmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - startinternalloadbalancervmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startinternalloadbalancervmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - startinternalloadbalancervmresponse
      x-cloudstack-command: startInternalLoadBalancerVM
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForRouter
      - destroyRouter
      - listInternalLoadBalancerVMs
      - listRouters
      - rebootRouter
      - stopInternalLoadBalancerVM
      - stopNetScalerVpx
      - stopRouter
      x-cloudstack-jobresult-schema: '#/components/schemas/Router'
  /startKubernetesCluster:
    get:
      operationId: startKubernetesCluster
      summary: Starts a stopped CloudManaged Kubernetes cluster
      description: |-
        Starts a stopped CloudManaged Kubernetes cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: startKubernetesCluster
          default: startKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - startKubernetesCluster
      responses:
        '200':
          description: Successful invocation of `startKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startkubernetesclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - startkubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startkubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - startkubernetesclusterresponse
      x-cloudstack-command: startKubernetesCluster
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/KubernetesCluster'
  /startRollingMaintenance:
    get:
      operationId: startRollingMaintenance
      summary: Start rolling maintenance
      description: |-
        Start rolling maintenance

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - RollingMaintenance
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: startRollingMaintenance
          default: startRollingMaintenance
      - $ref: '#/components/parameters/response'
      - name: clusterids
        in: query
        description: The IDs of the clusters to start maintenance on. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addCluster
        - listClusters
        - updateCluster
      - name: forced
        in: query
        description: If rolling mechanism should continue in case of an error
        schema:
          type: boolean
      - name: hostids
        in: query
        description: The IDs of the hosts to start maintenance on. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
        - updateHost
      - name: payload
        in: query
        description: The command to execute while hosts are on maintenance
        schema:
          type: string
          maxLength: 255
      - name: podids
        in: query
        description: The IDs of the pods to start maintenance on. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: timeout
        in: query
        description: Optional operation timeout (in seconds) that overrides the global timeout setting
        schema:
          type: integer
          format: int32
      - name: zoneids
        in: query
        description: The IDs of the zones to start maintenance on. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `startRollingMaintenance`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startrollingmaintenanceresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - startrollingmaintenanceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startrollingmaintenanceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - startrollingmaintenanceresponse
      x-cloudstack-command: startRollingMaintenance
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/RollingMaintenance'
  /startRouter:
    get:
      operationId: startRouter
      summary: Starts a router.
      description: |-
        Starts a router.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Router
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: startRouter
          default: startRouter
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the router
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - destroyRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - rebootRouter
        - startInternalLoadBalancerVM
        - startRouter
        - stopInternalLoadBalancerVM
        - stopNetScalerVpx
        - stopRouter
      responses:
        '200':
          description: Successful invocation of `startRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startrouterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - startrouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startrouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - startrouterresponse
      x-cloudstack-command: startRouter
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForRouter
      - destroyRouter
      - listInternalLoadBalancerVMs
      - listRouters
      - rebootRouter
      - startInternalLoadBalancerVM
      - stopInternalLoadBalancerVM
      - stopNetScalerVpx
      - stopRouter
      x-cloudstack-jobresult-schema: '#/components/schemas/Router'
  /startSharedFileSystem:
    get:
      operationId: startSharedFileSystem
      summary: Start a Shared FileSystem
      description: |-
        Start a Shared FileSystem

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: startSharedFileSystem
          default: startSharedFileSystem
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the shared filesystem
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
        - changeSharedFileSystemServiceOffering
        - listSharedFileSystems
        - startSharedFileSystem
        - stopSharedFileSystem
      responses:
        '200':
          description: Successful invocation of `startSharedFileSystem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startsharedfilesystemresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - startsharedfilesystemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startsharedfilesystemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - startsharedfilesystemresponse
      x-cloudstack-command: startSharedFileSystem
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - changeSharedFileSystemDiskOffering
      - changeSharedFileSystemServiceOffering
      - listSharedFileSystems
      - stopSharedFileSystem
      x-cloudstack-jobresult-schema: '#/components/schemas/SharedFileSystem'
  /startSystemVm:
    get:
      operationId: startSystemVm
      summary: Starts a System VM.
      description: |-
        Starts a System VM.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: startSystemVm
          default: startSystemVm
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the System VM
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - startSystemVm
      responses:
        '200':
          description: Successful invocation of `startSystemVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startsystemvmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - startsystemvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startsystemvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - startsystemvmresponse
      x-cloudstack-command: startSystemVm
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SystemVm'
  /startVirtualMachine:
    get:
      operationId: startVirtualMachine
      summary: Starts  an Instance.
      description: |-
        Starts  an Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: startVirtualMachine
          default: startVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: bootintosetup
        in: query
        description: Boot into hardware setup menu or not
        schema:
          type: boolean
        x-cloudstack-since: 4.15.0.0
      - name: clusterid
        in: query
        description: Destination Cluster ID to deploy the Instance to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: considerlasthost
        in: query
        description: True by default, CloudStack will firstly try to start the Instance on the last host where it run on before stopping, if destination host is not specified. If false, CloudStack will not consider the last host and start the Instance by normal process.
        schema:
          type: boolean
        x-cloudstack-since: 4.18.0
      - name: deploymentplanner
        in: query
        description: Deployment planner to use for Instance allocation. Available to ROOT admin only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: hostid
        in: query
        description: Destination Host ID to deploy the Instance to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 3.0.1
        x-cloudstack-related:
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      - name: podid
        in: query
        description: Destination Pod ID to deploy the Instance to - parameter available for root admin only
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
      responses:
        '200':
          description: Successful invocation of `startVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - startvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  startvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - startvirtualmachineresponse
      x-cloudstack-command: startVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /stopInternalLoadBalancerVM:
    get:
      operationId: stopInternalLoadBalancerVM
      summary: Stops an Internal LB Instance.
      description: |-
        Stops an Internal LB Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - InternalLoadBalancerVM
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: stopInternalLoadBalancerVM
          default: stopInternalLoadBalancerVM
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the internal LB Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - stopInternalLoadBalancerVM
      - name: forced
        in: query
        description: Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `stopInternalLoadBalancerVM`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopinternalloadbalancervmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - stopinternalloadbalancervmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopinternalloadbalancervmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - stopinternalloadbalancervmresponse
      x-cloudstack-command: stopInternalLoadBalancerVM
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForRouter
      - listInternalLoadBalancerVMs
      - listRouters
      x-cloudstack-jobresult-schema: '#/components/schemas/Router'
  /stopKubernetesCluster:
    get:
      operationId: stopKubernetesCluster
      summary: Stops a running CloudManaged Kubernetes cluster
      description: |-
        Stops a running CloudManaged Kubernetes cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: stopKubernetesCluster
          default: stopKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKubernetesCluster
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
      responses:
        '200':
          description: Successful invocation of `stopKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopkubernetesclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - stopkubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopkubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - stopkubernetesclusterresponse
      x-cloudstack-command: stopKubernetesCluster
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /stopNetScalerVpx:
    get:
      operationId: stopNetScalerVpx
      summary: Stops a NetScalervm.
      description: |-
        Stops a NetScalervm.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetScalerVpx
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: stopNetScalerVpx
          default: stopNetScalerVpx
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the NetScaler vm
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - rebootRouter
        - stopInternalLoadBalancerVM
        - stopNetScalerVpx
      - name: forced
        in: query
        description: Force stop the VM (vm is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the VM is stopped and should be marked as such.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `stopNetScalerVpx`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopnetscalervpxresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - stopnetscalervpxresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopnetscalervpxresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - stopnetscalervpxresponse
      x-cloudstack-command: stopNetScalerVpx
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForRouter
      - listInternalLoadBalancerVMs
      - listRouters
      - rebootRouter
      - stopInternalLoadBalancerVM
      x-cloudstack-jobresult-schema: '#/components/schemas/Router'
  /stopRouter:
    get:
      operationId: stopRouter
      summary: Stops a router.
      description: |-
        Stops a router.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Router
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: stopRouter
          default: stopRouter
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the router
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - rebootRouter
        - stopInternalLoadBalancerVM
        - stopNetScalerVpx
        - stopRouter
      - name: forced
        in: query
        description: Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `stopRouter`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stoprouterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - stoprouterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stoprouterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - stoprouterresponse
      x-cloudstack-command: stopRouter
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForRouter
      - listInternalLoadBalancerVMs
      - listRouters
      - rebootRouter
      - stopInternalLoadBalancerVM
      - stopNetScalerVpx
      x-cloudstack-jobresult-schema: '#/components/schemas/Router'
  /stopSharedFileSystem:
    get:
      operationId: stopSharedFileSystem
      summary: Stop a Shared FileSystem
      description: |-
        Stop a Shared FileSystem

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: stopSharedFileSystem
          default: stopSharedFileSystem
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the shared filesystem
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
        - changeSharedFileSystemServiceOffering
        - listSharedFileSystems
        - stopSharedFileSystem
      - name: forced
        in: query
        description: Force stop the shared filesystem.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `stopSharedFileSystem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopsharedfilesystemresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - stopsharedfilesystemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopsharedfilesystemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - stopsharedfilesystemresponse
      x-cloudstack-command: stopSharedFileSystem
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - changeSharedFileSystemDiskOffering
      - changeSharedFileSystemServiceOffering
      - listSharedFileSystems
      x-cloudstack-jobresult-schema: '#/components/schemas/SharedFileSystem'
  /stopSystemVm:
    get:
      operationId: stopSystemVm
      summary: Stops a system VM.
      description: |-
        Stops a system VM.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SystemVm
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: stopSystemVm
          default: stopSystemVm
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the System VM
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForSystemVm
        - listSystemVms
        - migrateSystemVm
        - startSystemVm
        - stopSystemVm
      - name: forced
        in: query
        description: Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). To be used if the caller knows the Instance is stopped and should be marked as such.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `stopSystemVm`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopsystemvmresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - stopsystemvmresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopsystemvmresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - stopsystemvmresponse
      x-cloudstack-command: stopSystemVm
      x-cloudstack-async: true
      x-cloudstack-related:
      - changeServiceForSystemVm
      - listSystemVms
      - migrateSystemVm
      - startSystemVm
      x-cloudstack-jobresult-schema: '#/components/schemas/SystemVm'
  /stopVirtualMachine:
    get:
      operationId: stopVirtualMachine
      summary: Stops  an Instance.
      description: |-
        Stops  an Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: stopVirtualMachine
          default: stopVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: forced
        in: query
        description: Force stop the Instance (Instance is marked as Stopped even when command fails to be send to the backend, otherwise a force poweroff is attempted). This option is to be used if the caller knows the Instance is stopped and should be marked as such.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `stopVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - stopvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  stopvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - stopvirtualmachineresponse
      x-cloudstack-command: stopVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /suspendProject:
    get:
      operationId: suspendProject
      summary: Suspends a project
      description: |-
        Suspends a project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: suspendProject
          default: suspendProject
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the project to be suspended
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      responses:
        '200':
          description: Successful invocation of `suspendProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  suspendprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - suspendprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  suspendprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - suspendprojectresponse
      x-cloudstack-command: suspendProject
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - activateProject
      - createProject
      x-cloudstack-jobresult-schema: '#/components/schemas/Project'
  /syncStoragePool:
    get:
      operationId: syncStoragePool
      summary: Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)
      description: |-
        Sync storage pool with management server (currently supported for Datastore Cluster in VMware and syncs the datastores in it)

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: syncStoragePool
          default: syncStoragePool
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Storage pool id
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
      responses:
        '200':
          description: Successful invocation of `syncStoragePool`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  syncstoragepoolresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - syncstoragepoolresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  syncstoragepoolresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - syncstoragepoolresponse
      x-cloudstack-command: syncStoragePool
      x-cloudstack-async: true
      x-cloudstack-since: 4.15.1
      x-cloudstack-related:
      - cancelStorageMaintenance
      - createStoragePool
      - enableStorageMaintenance
      - findStoragePoolsForMigration
      x-cloudstack-jobresult-schema: '#/components/schemas/StoragePool'
  /synchronizeTungstenFabricData:
    get:
      operationId: synchronizeTungstenFabricData
      summary: Synchronize Tungsten-Fabric data
      tags:
      - SynchronizeTungstenFabricData
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: synchronizeTungstenFabricData
          default: synchronizeTungstenFabricData
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Provider ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createTungstenFabricProvider
        - listTungstenFabricProviders
      responses:
        '200':
          description: Successful invocation of `synchronizeTungstenFabricData`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  synchronizetungstenfabricdataresponse:
                    oneOf:
                    - &id386
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id386
                        - type: array
                          items: *id386
                required:
                - synchronizetungstenfabricdataresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  synchronizetungstenfabricdataresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - synchronizetungstenfabricdataresponse
      x-cloudstack-command: synchronizeTungstenFabricData
      x-cloudstack-async: false
  /triggerShutdown:
    get:
      operationId: triggerShutdown
      summary: Triggers an automatic safe shutdown of CloudStack by not accepting new jobs and shutting down when all pending jobs have been completed.
      tags:
      - TriggerShutdown
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: triggerShutdown
          default: triggerShutdown
      - $ref: '#/components/parameters/response'
      - name: managementserverid
        in: query
        description: The UUID of the management server
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listManagementServers
      responses:
        '200':
          description: Successful invocation of `triggerShutdown`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  triggershutdownresponse:
                    oneOf:
                    - &id387
                      $ref: '#/components/schemas/CancelMaintenanceResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id387
                        - type: array
                          items: *id387
                required:
                - triggershutdownresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  triggershutdownresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - triggershutdownresponse
      x-cloudstack-command: triggerShutdown
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - cancelMaintenance
      - cancelShutdown
      - prepareForMaintenance
      - prepareForShutdown
      - readyForShutdown
  /unlinkDomainFromLdap:
    get:
      operationId: unlinkDomainFromLdap
      summary: remove the linkage of a Domain to a group or OU in ldap
      tags:
      - UnlinkDomainFromLdap
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: unlinkDomainFromLdap
          default: unlinkDomainFromLdap
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: The ID of the Domain which has to be unlinked from LDAP.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      responses:
        '200':
          description: Successful invocation of `unlinkDomainFromLdap`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unlinkdomainfromldapresponse:
                    oneOf:
                    - &id388
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id388
                        - type: array
                          items: *id388
                required:
                - unlinkdomainfromldapresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unlinkdomainfromldapresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - unlinkdomainfromldapresponse
      x-cloudstack-command: unlinkDomainFromLdap
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /unmanageGpuDevice:
    get:
      operationId: unmanageGpuDevice
      summary: Unmanage a GPU device
      tags:
      - GpuDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: unmanageGpuDevice
          default: unmanageGpuDevice
      - $ref: '#/components/parameters/response'
      - name: ids
        in: query
        description: comma separated list of IDs of the GPU device. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - createGpuDevice
        - discoverGpuDevices
        - listGpuDevices
        - updateGpuDevice
      responses:
        '200':
          description: Successful invocation of `unmanageGpuDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unmanagegpudeviceresponse:
                    oneOf:
                    - &id389
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id389
                        - type: array
                          items: *id389
                required:
                - unmanagegpudeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unmanagegpudeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - unmanagegpudeviceresponse
      x-cloudstack-command: unmanageGpuDevice
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /unmanageVirtualMachine:
    get:
      operationId: unmanageVirtualMachine
      summary: Unmanage a Guest Instance.
      description: |-
        Unmanage a Guest Instance.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: unmanageVirtualMachine
          default: unmanageVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance to unmanage
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: forced
        in: query
        description: Force unmanaging Instance with config drive. Applicable only for KVM Hypervisor.
        schema:
          type: boolean
        x-cloudstack-since: 4.22.0
      - name: hostid
        in: query
        description: ID of the host which will be used for unmanaging the Instance. Applicable only for KVM hypervisor and stopped Instances. Domain XML will be stored on this host.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.22.0
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `unmanageVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unmanagevirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - unmanagevirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unmanagevirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - unmanagevirtualmachineresponse
      x-cloudstack-command: unmanageVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-since: 4.15.0
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine2'
  /unmanageVolume:
    get:
      operationId: unmanageVolume
      summary: Unmanage a volume on storage pool.
      description: |-
        Unmanage a volume on storage pool.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: unmanageVolume
          default: unmanageVolume
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the volume to unmanage
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - assignVolume
        - attachVolume
        - changeOfferingForVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      responses:
        '200':
          description: Successful invocation of `unmanageVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unmanagevolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - unmanagevolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unmanagevolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - unmanagevolumeresponse
      x-cloudstack-command: unmanageVolume
      x-cloudstack-async: true
      x-cloudstack-since: 4.19.1
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /unregisterExtension:
    get:
      operationId: unregisterExtension
      summary: Unregister an extension with a resource
      tags:
      - Extension
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: unregisterExtension
          default: unregisterExtension
      - $ref: '#/components/parameters/response'
      - name: extensionid
        in: query
        description: ID of the extension
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listExtensions
        - unregisterExtension
        - updateExtension
      - name: resourceid
        in: query
        description: ID of the resource to register the extension with
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `unregisterExtension`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unregisterextensionresponse:
                    oneOf:
                    - &id390
                      $ref: '#/components/schemas/Extension'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id390
                        - type: array
                          items: *id390
                required:
                - unregisterextensionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  unregisterextensionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - unregisterextensionresponse
      x-cloudstack-command: unregisterExtension
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - listExtensions
      - updateExtension
  /updateAccount:
    get:
      operationId: updateAccount
      summary: Updates Account information for the authenticated user
      tags:
      - Account
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateAccount
          default: updateAccount
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Current Account name
        schema:
          type: string
          maxLength: 255
      - name: accountdetails
        in: query
        description: Details for the Account used to store specific parameters. Map parameter. CloudStack expects it index-encoded as `accountdetails[0].key=k&accountdetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: apikeyaccess
        in: query
        description: Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the domain level setting api.key.access
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1.0
      - name: domainid
        in: query
        description: The UUID of the domain where the Account exists
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: id
        in: query
        description: Account UUID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - updateAccount
      - name: networkdomain
        in: query
        description: Network domain for the Account's networks; empty string will update domainName with NULL value
        schema:
          type: string
          maxLength: 255
      - name: newname
        in: query
        description: New name for the Account
        schema:
          type: string
          maxLength: 255
      - name: roleid
        in: query
        description: The UUID of the dynamic role to set for the Account
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - listRoles
        - updateRole
      responses:
        '200':
          description: Successful invocation of `updateAccount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateaccountresponse:
                    oneOf:
                    - &id391
                      $ref: '#/components/schemas/Account'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id391
                        - type: array
                          items: *id391
                required:
                - updateaccountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateaccountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateaccountresponse
      x-cloudstack-command: updateAccount
      x-cloudstack-async: false
      x-cloudstack-related:
      - disableAccount
      - enableAccount
      - listAccounts
  /updateAnnotationVisibility:
    get:
      operationId: updateAnnotationVisibility
      summary: Update an annotation visibility.
      tags:
      - AnnotationVisibility
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateAnnotationVisibility
          default: updateAnnotationVisibility
      - $ref: '#/components/parameters/response'
      - name: adminsonly
        in: query
        description: The annotation is visible for admins only
        required: true
        schema:
          type: boolean
      - name: id
        in: query
        description: The ID of the annotation
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateAnnotationVisibility`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateannotationvisibilityresponse:
                    oneOf:
                    - &id392
                      $ref: '#/components/schemas/Annotation'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id392
                        - type: array
                          items: *id392
                required:
                - updateannotationvisibilityresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateannotationvisibilityresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateannotationvisibilityresponse
      x-cloudstack-command: updateAnnotationVisibility
      x-cloudstack-async: false
      x-cloudstack-since: '4.16'
      x-cloudstack-related:
      - addAnnotation
      - listAnnotations
      - removeAnnotation
  /updateAutoScalePolicy:
    get:
      operationId: updateAutoScalePolicy
      summary: Updates an existing autoscale policy.
      description: |-
        Updates an existing autoscale policy.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScalePolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateAutoScalePolicy
          default: updateAutoScalePolicy
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the autoscale policy
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listAutoScalePolicies
        - updateAutoScalePolicy
      - name: conditionids
        in: query
        description: The list of IDs of the conditions that are being evaluated on every interval. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listConditions
      - name: duration
        in: query
        description: The duration in which the conditions have to be true before action is taken
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: The name of the autoscale policy
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: quiettime
        in: query
        description: The cool down period in which the policy should not be evaluated after the action has been taken
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `updateAutoScalePolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateautoscalepolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateautoscalepolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateautoscalepolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateautoscalepolicyresponse
      x-cloudstack-command: updateAutoScalePolicy
      x-cloudstack-async: true
      x-cloudstack-related:
      - listAutoScalePolicies
      x-cloudstack-jobresult-schema: '#/components/schemas/AutoScalePolicy'
  /updateAutoScaleVmGroup:
    get:
      operationId: updateAutoScaleVmGroup
      summary: Updates an existing autoscale Instance group.
      description: |-
        Updates an existing autoscale Instance group.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScaleVmGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateAutoScaleVmGroup
          default: updateAutoScaleVmGroup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the autoscale group
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - enableAutoScaleVmGroup
        - listAutoScaleVmGroups
        - updateAutoScaleVmGroup
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the group to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: interval
        in: query
        description: The frequency in which the performance counters to be collected
        schema:
          type: integer
          format: int32
      - name: maxmembers
        in: query
        description: The maximum number of members in the vmgroup, The number of Instances in the Instance group will be equal to or less than this number.
        schema:
          type: integer
          format: int32
      - name: minmembers
        in: query
        description: The minimum number of members in the vmgroup, the number of Instances in the Instance group will be equal to or more than this number.
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: The name of the autoscale vmgroup
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: scaledownpolicyids
        in: query
        description: List of scaledown autoscale policies. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listAutoScalePolicies
        - updateAutoScalePolicy
      - name: scaleuppolicyids
        in: query
        description: List of scaleup autoscale policies. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listAutoScalePolicies
        - updateAutoScalePolicy
      responses:
        '200':
          description: Successful invocation of `updateAutoScaleVmGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateautoscalevmgroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateautoscalevmgroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateautoscalevmgroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateautoscalevmgroupresponse
      x-cloudstack-command: updateAutoScaleVmGroup
      x-cloudstack-async: true
      x-cloudstack-related:
      - enableAutoScaleVmGroup
      - listAutoScaleVmGroups
      x-cloudstack-jobresult-schema: '#/components/schemas/AutoScaleVmGroup'
  /updateAutoScaleVmProfile:
    get:
      operationId: updateAutoScaleVmProfile
      summary: Updates an existing autoscale Instance profile.
      description: |-
        Updates an existing autoscale Instance profile.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AutoScaleVmProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateAutoScaleVmProfile
          default: updateAutoScaleVmProfile
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the autoscale Instance profile
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listAutoScaleVmProfiles
        - updateAutoScaleVmProfile
      - name: autoscaleuserid
        in: query
        description: The ID of the user used to launch and destroy the Instances
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableUser
        - getUser
        - listUsers
        - lockUser
      - name: counterparam
        in: query
        description: 'counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161. Map parameter. CloudStack expects it index-encoded as `counterparam[0].key=k&counterparam[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: expungevmgraceperiod
        in: query
        description: The time allowed for existing connections to get closed before an Instance is destroyed
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the profile to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: otherdeployparams
        in: query
        description: "Parameters other than zoneId/serviceOfferringId/templateId of the auto deployed  Instance. \nExample: otherdeployparams[0].name=serviceofferingid&otherdeployparams[0].value=a7fb50f6-01d9-11ed-8bc1-77f8f0228926&otherdeployparams[1].name=rootdisksize&otherdeployparams[1].value=10 .\nPossible parameters are \"rootdisksize\", \"diskofferingid\",\"size\", \"securitygroupids\", \"overridediskofferingid\", \"keypairs\", \"affinitygroupids'\" and \"networkids\". Map parameter. CloudStack expects it index-encoded as `otherdeployparams[0].key=k&otherdeployparams[0].value=v`."
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.18.0
      - name: serviceofferingid
        in: query
        description: The service offering of the auto deployed  Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.18.0
        x-cloudstack-related:
        - listServiceOfferings
        - updateServiceOffering
      - name: templateid
        in: query
        description: The Template of the auto deployed Instance
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: userdata
        in: query
        description: An optional binary data that can be sent to the  Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value
        schema:
          type: string
          maxLength: 1048576
        x-cloudstack-since: 4.18.0
      - name: userdatadetails
        in: query
        description: used to specify the parameters values for the variables in userdata. Map parameter. CloudStack expects it index-encoded as `userdatadetails[0].key=k&userdatadetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.18.1
      - name: userdataid
        in: query
        description: the ID of the userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.18.1
      responses:
        '200':
          description: Successful invocation of `updateAutoScaleVmProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateautoscalevmprofileresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateautoscalevmprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateautoscalevmprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateautoscalevmprofileresponse
      x-cloudstack-command: updateAutoScaleVmProfile
      x-cloudstack-async: true
      x-cloudstack-related:
      - listAutoScaleVmProfiles
      x-cloudstack-jobresult-schema: '#/components/schemas/AutoScaleVmProfile'
  /updateBackupOffering:
    get:
      operationId: updateBackupOffering
      summary: Updates a backup offering.
      tags:
      - BackupOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateBackupOffering
          default: updateBackupOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Backup Offering to be updated
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createBackupOffering
        - updateBackupOffering
      - name: allowuserdrivenbackups
        in: query
        description: Whether to allow user driven backups or not
        schema:
          type: boolean
      - name: description
        in: query
        description: The description of the Backup Offering to be updated
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: the ID of the containing domain(s) as comma separated string, public for public offerings
        schema:
          type: string
          maxLength: 4096
        x-cloudstack-since: 4.23.0
      - name: name
        in: query
        description: The name of the Backup Offering to be updated
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateBackupOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebackupofferingresponse:
                    oneOf:
                    - &id393
                      $ref: '#/components/schemas/BackupOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id393
                        - type: array
                          items: *id393
                required:
                - updatebackupofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebackupofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatebackupofferingresponse
      x-cloudstack-command: updateBackupOffering
      x-cloudstack-async: false
      x-cloudstack-since: 4.16.0
      x-cloudstack-related:
      - createBackupOffering
  /updateBackupRepository:
    get:
      operationId: updateBackupRepository
      summary: Update a backup repository
      tags:
      - BackupRepository
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateBackupRepository
          default: updateBackupRepository
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the backup repository
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBackupRepository
        - listBackupRepositories
        - updateBackupRepository
      - name: address
        in: query
        description: address of the backup repository
        schema:
          type: string
          maxLength: 255
      - name: crosszoneinstancecreation
        in: query
        description: backups in this repository can be used to create Instances on all Zones
        schema:
          type: boolean
      - name: mountopts
        in: query
        description: shared storage mount options
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: name of the backup repository
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateBackupRepository`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebackuprepositoryresponse:
                    oneOf:
                    - &id394
                      $ref: '#/components/schemas/BackupRepository'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id394
                        - type: array
                          items: *id394
                required:
                - updatebackuprepositoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebackuprepositoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatebackuprepositoryresponse
      x-cloudstack-command: updateBackupRepository
      x-cloudstack-async: false
      x-cloudstack-since: 4.22.0
      x-cloudstack-related:
      - addBackupRepository
      - listBackupRepositories
  /updateBackupSchedule:
    get:
      operationId: updateBackupSchedule
      summary: Updates a User-defined Instance backup schedule
      tags:
      - BackupSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateBackupSchedule
          default: updateBackupSchedule
      - $ref: '#/components/parameters/response'
      - name: intervaltype
        in: query
        description: Valid values are HOURLY, DAILY, WEEKLY, and MONTHLY
        required: true
        schema:
          type: string
          maxLength: 255
      - name: schedule
        in: query
        description: Custom backup schedule, the format is:for HOURLY MM*, for DAILY MM:HH*, for WEEKLY MM:HH:DD (1-7)*, for MONTHLY MM:HH:DD (1-28)
        required: true
        schema:
          type: string
          maxLength: 255
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: virtualmachineid
        in: query
        description: ID of the Instance for which schedule is to be defined
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: isolated
        in: query
        description: Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: maxbackups
        in: query
        description: The maximum number of backups to keep for a VM. If "0", no retention policy will be applied and, thus, no backups from the schedule will be automatically deleted. This parameter is only supported for the Dummy, NAS and EMC Networker backup provider.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.21.0
      - name: quiescevm
        in: query
        description: Quiesce the Instance before checkpointing the disks for backup. Applicable only to NAS and KBOSS backup providers. The filesystem is frozen before the backup starts and thawed immediately after. Requires the instance to have the QEMU Guest Agent installed and running.
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      responses:
        '200':
          description: Successful invocation of `updateBackupSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebackupscheduleresponse:
                    oneOf:
                    - &id395
                      $ref: '#/components/schemas/ListBackupsResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id395
                        - type: array
                          items: *id395
                required:
                - updatebackupscheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebackupscheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatebackupscheduleresponse
      x-cloudstack-command: updateBackupSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0
  /updateBgpPeer:
    get:
      operationId: updateBgpPeer
      summary: Updates an existing Bgp Peer.
      description: |-
        Updates an existing Bgp Peer.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - BgpPeer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateBgpPeer
          default: updateBgpPeer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the Bgp Peer
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createBgpPeer
        - dedicateBgpPeer
        - listBgpPeers
        - releaseBgpPeer
        - updateBgpPeer
      - name: asnumber
        in: query
        description: The AS number of the Bgp Peer.
        schema:
          type: integer
          format: int64
      - name: cleanupdetails
        in: query
        description: optional boolean field, which indicates if details should be cleaned up or not (if set to true, details are removed for this resource; if false or not set, no action)
        schema:
          type: boolean
      - name: details
        in: query
        description: BGP peer details in key/value pairs. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: ip6address
        in: query
        description: The IPv6 address of the Bgp Peer.
        schema:
          type: string
          maxLength: 255
      - name: ipaddress
        in: query
        description: The IPv4 address of the Bgp Peer.
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: The password of the Bgp Peer.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateBgpPeer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebgppeerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatebgppeerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebgppeerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatebgppeerresponse
      x-cloudstack-command: updateBgpPeer
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createBgpPeer
      - dedicateBgpPeer
      - listBgpPeers
      - releaseBgpPeer
      x-cloudstack-jobresult-schema: '#/components/schemas/BgpPeer'
  /updateBucket:
    get:
      operationId: updateBucket
      summary: Updates Bucket properties
      tags:
      - Bucket
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateBucket
          default: updateBucket
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Bucket
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: encryption
        in: query
        description: Enable/Disable Bucket encryption
        schema:
          type: boolean
      - name: policy
        in: query
        description: Bucket Access Policy
        schema:
          type: string
          maxLength: 255
      - name: quota
        in: query
        description: Bucket Quota in GiB
        schema:
          type: integer
          format: int32
      - name: versioning
        in: query
        description: Enable/Disable Bucket Versioning
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `updateBucket`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebucketresponse:
                    oneOf:
                    - &id396
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id396
                        - type: array
                          items: *id396
                required:
                - updatebucketresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatebucketresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatebucketresponse
      x-cloudstack-command: updateBucket
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /updateCloudToUseObjectStore:
    get:
      operationId: updateCloudToUseObjectStore
      summary: Migrate current NFS secondary storages to use object store.
      tags:
      - CloudToUseObjectStore
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateCloudToUseObjectStore
          default: updateCloudToUseObjectStore
      - $ref: '#/components/parameters/response'
      - name: provider
        in: query
        description: The image store provider name
        required: true
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'The details for the image store. Example: details[0].key=accesskey&details[0].value=s389ddssaa&details[1].key=secretkey&details[1].value=8dshfsss. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: name
        in: query
        description: The name for the image store
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The URL for the image store
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateCloudToUseObjectStore`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatecloudtouseobjectstoreresponse:
                    oneOf:
                    - &id397
                      $ref: '#/components/schemas/ImageStore'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id397
                        - type: array
                          items: *id397
                required:
                - updatecloudtouseobjectstoreresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatecloudtouseobjectstoreresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatecloudtouseobjectstoreresponse
      x-cloudstack-command: updateCloudToUseObjectStore
      x-cloudstack-async: false
      x-cloudstack-since: 4.3.0
      x-cloudstack-related:
      - addImageStore
      - addImageStoreS3
      - addSecondaryStorage
      - addSwift
      - listImageStores
      - listSwifts
  /updateCluster:
    get:
      operationId: updateCluster
      summary: Updates an existing cluster
      tags:
      - Cluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateCluster
          default: updateCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: allocationstate
        in: query
        description: Allocation state of this cluster for allocation of new resources
        schema:
          type: string
          maxLength: 255
      - name: arch
        in: query
        description: 'the CPU arch of the cluster. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: clustername
        in: query
        description: The cluster name
        schema:
          type: string
          maxLength: 255
      - name: clustertype
        in: query
        description: Hypervisor type of the cluster
        schema:
          type: string
          maxLength: 255
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs to be added to the extension-resource mapping. Use the format externaldetails[i].<key>=<value>. Example: externaldetails[0].endpoint.url=https://example.com. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: hypervisor
        in: query
        description: Hypervisor type of the cluster
        schema:
          type: string
          maxLength: 255
      - name: managedstate
        in: query
        description: Whether this cluster is managed by cloudstack
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateclusterresponse:
                    oneOf:
                    - &id398
                      $ref: '#/components/schemas/Cluster'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id398
                        - type: array
                          items: *id398
                required:
                - updateclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateclusterresponse
      x-cloudstack-command: updateCluster
      x-cloudstack-async: false
      x-cloudstack-related:
      - addCluster
  /updateCondition:
    get:
      operationId: updateCondition
      summary: Updates a condition for Instance auto scaling
      description: |-
        Updates a condition for Instance auto scaling

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Condition
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateCondition
          default: updateCondition
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the condition.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listConditions
      - name: relationaloperator
        in: query
        description: Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: threshold
        in: query
        description: Value for which the Counter will be evaluated with the Operator selected.
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `updateCondition`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateconditionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateconditionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateconditionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateconditionresponse
      x-cloudstack-command: updateCondition
      x-cloudstack-async: true
      x-cloudstack-since: 4.18.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /updateConfiguration:
    get:
      operationId: updateConfiguration
      summary: Updates a configuration.
      tags:
      - Configuration
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateConfiguration
          default: updateConfiguration
      - $ref: '#/components/parameters/response'
      - name: name
        in: query
        description: The name of the configuration
        required: true
        schema:
          type: string
          maxLength: 255
      - name: accountid
        in: query
        description: The ID of the Account to update the parameter value for corresponding account
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - disableAccount
        - enableAccount
        - listAccounts
        - lockAccount
        - markDefaultZoneForAccount
        - updateAccount
      - name: clusterid
        in: query
        description: The ID of the Cluster to update the parameter value for corresponding cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: domainid
        in: query
        description: The ID of the Domain to update the parameter value for corresponding domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: imagestoreuuid
        in: query
        description: The ID of the Image Store to update the parameter value for corresponding image store
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addImageStoreS3
        - addSecondaryStorage
        - addSwift
        - listImageStores
        - listSwifts
      - name: managementserverid
        in: query
        description: the ID of the Management Server to update the parameter value for corresponding management server
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - listManagementServers
      - name: storageid
        in: query
        description: The ID of the Storage pool to update the parameter value for corresponding storage pool
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: value
        in: query
        description: The value of the configuration
        schema:
          type: string
          maxLength: 4096
      - name: zoneid
        in: query
        description: The ID of the Zone to update the parameter value for corresponding zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
      responses:
        '200':
          description: Successful invocation of `updateConfiguration`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateconfigurationresponse:
                    oneOf:
                    - &id399
                      $ref: '#/components/schemas/Configuration'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id399
                        - type: array
                          items: *id399
                required:
                - updateconfigurationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateconfigurationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateconfigurationresponse
      x-cloudstack-command: updateConfiguration
      x-cloudstack-async: false
      x-cloudstack-related:
      - listConfigurations
  /updateCustomAction:
    get:
      operationId: updateCustomAction
      summary: Update the custom action
      tags:
      - CustomAction
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateCustomAction
          default: updateCustomAction
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the custom action
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCustomAction
        - listCustomActions
      - name: allowedroletypes
        in: query
        description: List of role types allowed for the action. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: cleanupdetails
        in: query
        description: Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this action, details field ignored; if false or not set, no action)
        schema:
          type: boolean
      - name: cleanupparameters
        in: query
        description: Optional boolean field, which indicates if parameters should be cleaned up or not (If set to true, parameters will be removed for this action, parameters field ignored; if false or not set, no action)
        schema:
          type: boolean
      - name: description
        in: query
        description: The description of the command
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: enabled
        in: query
        description: Whether the action is enabled or not
        schema:
          type: boolean
      - name: errormessage
        in: query
        description: 'Error message that will be used on failure during execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Failed to complete {{actionName}} for {{extensionName'
        schema:
          type: string
          maxLength: 255
      - name: parameters
        in: query
        description: 'Parameters mapping for the action using keys - name, type, required. ''name'' is mandatory. If ''type'' is not specified then STRING will be used. If ''required'' is not specified then false will be used. Example: parameters[0].name=xxx&parameters[0].type=BOOLEAN&parameters[0].required=true. Map parameter. CloudStack expects it index-encoded as `parameters[0].key=k&parameters[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: resourcetype
        in: query
        description: Type of the resource for actions
        schema:
          type: string
          maxLength: 255
      - name: successmessage
        in: query
        description: 'Success message that will be used on successful execution of the action. Name of the action and and extension can be used in the - actionName, extensionName. Example: Successfully complete {{actionName}} for {{extensionName'
        schema:
          type: string
          maxLength: 255
      - name: timeout
        in: query
        description: Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `updateCustomAction`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatecustomactionresponse:
                    oneOf:
                    - &id400
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id400
                        - type: array
                          items: *id400
                required:
                - updatecustomactionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatecustomactionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatecustomactionresponse
      x-cloudstack-command: updateCustomAction
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
  /updateDefaultNicForVirtualMachine:
    get:
      operationId: updateDefaultNicForVirtualMachine
      summary: Changes the default NIC on an Instance
      description: |-
        Changes the default NIC on an Instance

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateDefaultNicForVirtualMachine
          default: updateDefaultNicForVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: nicid
        in: query
        description: NIC ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listNics
        - updateVmNic
      - name: virtualmachineid
        in: query
        description: Instance ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - assignVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importUnmanagedInstance
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - migrateVirtualMachine
        - migrateVirtualMachineWithVolume
        - rebootVirtualMachine
        - recoverVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      responses:
        '200':
          description: Successful invocation of `updateDefaultNicForVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatedefaultnicforvirtualmachineresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatedefaultnicforvirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatedefaultnicforvirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatedefaultnicforvirtualmachineresponse
      x-cloudstack-command: updateDefaultNicForVirtualMachine
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachine
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /updateDiskOffering:
    get:
      operationId: updateDiskOffering
      summary: Updates a disk offering.
      tags:
      - DiskOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateDiskOffering
          default: updateDiskOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the disk offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cloneDiskOffering
        - createDiskOffering
        - listDiskOfferings
        - updateDiskOffering
      - name: bytesreadrate
        in: query
        description: Bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: bytesreadratemax
        in: query
        description: Burst bytes read rate of the disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: bytesreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: byteswriterate
        in: query
        description: Bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: byteswriteratemax
        in: query
        description: Burst bytes write rate of the disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: byteswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: cachemode
        in: query
        description: The cache mode to use for this disk offering
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.15'
      - name: displayoffering
        in: query
        description: An optional field, whether to display the offering to the end user or not.
        schema:
          type: boolean
      - name: displaytext
        in: query
        description: Updates alternate display text of the disk offering with this value
        schema:
          type: string
          maxLength: 4096
      - name: domainid
        in: query
        description: The ID of the containing domain(s) as comma separated string, public for public offerings
        schema:
          type: string
          maxLength: 4096
        x-cloudstack-since: '4.13'
      - name: iopsreadrate
        in: query
        description: I/O requests read rate of the disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: iopsreadratemax
        in: query
        description: Burst requests read rate of the disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: iopsreadratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: iopswriterate
        in: query
        description: I/O requests write rate of the disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: iopswriteratemax
        in: query
        description: Burst io requests write rate of the disk offering
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: iopswriteratemaxlength
        in: query
        description: Length (in seconds) of the burst
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.15'
      - name: name
        in: query
        description: Updates name of the disk offering with this value
        schema:
          type: string
          maxLength: 255
      - name: sortkey
        in: query
        description: Sort key of the disk offering, integer
        schema:
          type: integer
          format: int32
      - name: state
        in: query
        description: state of the disk offering
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: Comma-separated list of tags for the disk offering, tags should match with existing storage pool tags
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.15'
      - name: zoneid
        in: query
        description: The ID of the containing zone(s) as comma separated string, all for all zones offerings
        schema:
          type: string
          maxLength: 4096
        x-cloudstack-since: '4.13'
      responses:
        '200':
          description: Successful invocation of `updateDiskOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatediskofferingresponse:
                    oneOf:
                    - &id401
                      $ref: '#/components/schemas/DiskOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id401
                        - type: array
                          items: *id401
                required:
                - updatediskofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatediskofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatediskofferingresponse
      x-cloudstack-command: updateDiskOffering
      x-cloudstack-async: false
      x-cloudstack-related:
      - cloneDiskOffering
      - createDiskOffering
      - listDiskOfferings
  /updateDnsServer:
    get:
      operationId: updateDnsServer
      summary: Update DNS server
      tags:
      - DnsServer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateDnsServer
          default: updateDnsServer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the DNS server to update
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addDnsServer
        - listDnsServers
        - updateDnsServer
      - name: dnsapikey
        in: query
        description: API Key or Credentials for the external provider
        schema:
          type: string
          maxLength: 255
      - name: ispublic
        in: query
        description: Whether this DNS server can be used by accounts other than the owner to create and manage DNS zones
        schema:
          type: boolean
      - name: name
        in: query
        description: Name of the DNS server
        schema:
          type: string
          maxLength: 255
      - name: nameservers
        in: query
        description: Comma separated list of name servers; used to create NS records for the DNS Zone (for example, ns1.example.com, ns2.example.com). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: port
        in: query
        description: Port number of the external DNS server
        schema:
          type: integer
          format: int32
      - name: publicdomainsuffix
        in: query
        description: Domain suffix that restricts DNS zones created by non-owner accounts to subdomains of this suffix (for example, sub.example.com under example.com)
        schema:
          type: string
          maxLength: 255
      - name: state
        in: query
        description: Update state for the DNS server (Enabled, Disabled)
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: API URL of the provider
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateDnsServer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatednsserverresponse:
                    oneOf:
                    - &id402
                      $ref: '#/components/schemas/DnsServer'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id402
                        - type: array
                          items: *id402
                required:
                - updatednsserverresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatednsserverresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatednsserverresponse
      x-cloudstack-command: updateDnsServer
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - addDnsServer
      - listDnsServers
  /updateDnsZone:
    get:
      operationId: updateDnsZone
      summary: Updates a DNS Zone's metadata
      tags:
      - DnsZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateDnsZone
          default: updateDnsZone
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the DNS zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDnsZone
        - listDnsZones
        - updateDnsZone
      - name: description
        in: query
        description: The description of the DNS zone to be updated
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateDnsZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatednszoneresponse:
                    oneOf:
                    - &id403
                      $ref: '#/components/schemas/DnsZone'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id403
                        - type: array
                          items: *id403
                required:
                - updatednszoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatednszoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatednszoneresponse
      x-cloudstack-command: updateDnsZone
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createDnsZone
      - listDnsZones
  /updateDomain:
    get:
      operationId: updateDomain
      summary: Updates a domain with a new name
      tags:
      - Domain
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateDomain
          default: updateDomain
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of domain to update
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: name
        in: query
        description: Updates domain with this name
        schema:
          type: string
          maxLength: 255
      - name: networkdomain
        in: query
        description: Network domain for the domain's networks; empty string will update domainName with NULL value
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateDomain`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatedomainresponse:
                    oneOf:
                    - &id404
                      $ref: '#/components/schemas/Domain'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id404
                        - type: array
                          items: *id404
                required:
                - updatedomainresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatedomainresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatedomainresponse
      x-cloudstack-command: updateDomain
      x-cloudstack-async: false
      x-cloudstack-related:
      - createDomain
      - listDomainChildren
      - listDomains
      - moveDomain
  /updateEgressFirewallRule:
    get:
      operationId: updateEgressFirewallRule
      summary: Updates egress firewall rule
      description: |-
        Updates egress firewall rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - EgressFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateEgressFirewallRule
          default: updateEgressFirewallRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the egress firewall rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateEgressFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateegressfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateegressfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateegressfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateegressfirewallruleresponse
      x-cloudstack-command: updateEgressFirewallRule
      x-cloudstack-async: true
      x-cloudstack-since: '4.4'
      x-cloudstack-jobresult-schema: '#/components/schemas/EgressFirewallRule'
  /updateExtension:
    get:
      operationId: updateExtension
      summary: Update the extension
      tags:
      - Extension
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateExtension
          default: updateExtension
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the extension
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listExtensions
        - updateExtension
      - name: cleanupdetails
        in: query
        description: Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this extension, details field ignored; if false or not set, no action)
        schema:
          type: boolean
      - name: description
        in: query
        description: Description of the extension
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: orchestratorrequirespreparevm
        in: query
        description: Only honored when type is Orchestrator. Whether prepare VM is needed or not
        schema:
          type: boolean
      - name: reservedresourcedetails
        in: query
        description: Resource detail names as comma separated string that should be reserved and not visible to end users
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.22.1
      - name: state
        in: query
        description: State of the extension
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateExtension`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateextensionresponse:
                    oneOf:
                    - &id405
                      $ref: '#/components/schemas/Extension'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id405
                        - type: array
                          items: *id405
                required:
                - updateextensionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateextensionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateextensionresponse
      x-cloudstack-command: updateExtension
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - listExtensions
  /updateFirewallRule:
    get:
      operationId: updateFirewallRule
      summary: Updates firewall rule
      description: |-
        Updates firewall rule

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - FirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateFirewallRule
          default: updateFirewallRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the firewall rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updatePortForwardingRule
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatefirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatefirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatefirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatefirewallruleresponse
      x-cloudstack-command: updateFirewallRule
      x-cloudstack-async: true
      x-cloudstack-since: '4.4'
      x-cloudstack-related:
      - createFirewallRule
      - listFirewallRules
      - updateEgressFirewallRule
      x-cloudstack-jobresult-schema: '#/components/schemas/EgressFirewallRule'
  /updateGlobalLoadBalancerRule:
    get:
      operationId: updateGlobalLoadBalancerRule
      summary: Update global load balancer rules.
      description: |-
        Update global load balancer rules.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GlobalLoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateGlobalLoadBalancerRule
          default: updateGlobalLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the global load balancer rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateGlobalLoadBalancerRule
      - name: description
        in: query
        description: The description of the load balancer rule
        schema:
          type: string
          maxLength: 4096
      - name: gslblbmethod
        in: query
        description: Load balancer algorithm (roundrobin, leastconn, proximity) that is used to distributed traffic across the zones participating in global server load balancing, if not specified defaults to 'round robin'
        schema:
          type: string
          maxLength: 255
      - name: gslbstickysessionmethodname
        in: query
        description: Session sticky method (sourceip) if not specified defaults to sourceip
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateGlobalLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updategloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updategloballoadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updategloballoadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updategloballoadbalancerruleresponse
      x-cloudstack-command: updateGlobalLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/GlobalLoadBalancerRule'
  /updateGpuCard:
    get:
      operationId: updateGpuCard
      summary: Updates a GPU card definition in the system
      tags:
      - GpuCard
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateGpuCard
          default: updateGpuCard
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the GPU card
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGpuCards
        - updateGpuCard
      - name: devicename
        in: query
        description: the device name of the GPU card
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: the display name of the GPU card
        schema:
          type: string
          maxLength: 255
      - name: vendorname
        in: query
        description: the vendor name of the GPU card
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateGpuCard`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updategpucardresponse:
                    oneOf:
                    - &id406
                      $ref: '#/components/schemas/GpuCard'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id406
                        - type: array
                          items: *id406
                required:
                - updategpucardresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updategpucardresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updategpucardresponse
      x-cloudstack-command: updateGpuCard
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - listGpuCards
  /updateGpuDevice:
    get:
      operationId: updateGpuDevice
      summary: Updates an existing GPU device
      tags:
      - GpuDevice
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateGpuDevice
          default: updateGpuDevice
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the GPU device to update
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createGpuDevice
        - discoverGpuDevices
        - listGpuDevices
        - updateGpuDevice
      - name: gpucardid
        in: query
        description: New GPU card ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listGpuCards
      - name: numanode
        in: query
        description: New NUMA node of the GPU device
        schema:
          type: string
          maxLength: 255
      - name: parentgpudeviceid
        in: query
        description: New parent GPU device ID (for virtual GPU devices)
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createGpuDevice
        - discoverGpuDevices
        - listGpuDevices
        - updateGpuDevice
      - name: type
        in: query
        description: New type of GPU device (PCI, MDEV, VGPUOnly)
        schema:
          type: string
          maxLength: 255
      - name: vgpuprofileid
        in: query
        description: New vGPU profile ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVgpuProfile
        - updateVgpuProfile
      responses:
        '200':
          description: Successful invocation of `updateGpuDevice`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updategpudeviceresponse:
                    oneOf:
                    - &id407
                      $ref: '#/components/schemas/GpuDevice'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id407
                        - type: array
                          items: *id407
                required:
                - updategpudeviceresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updategpudeviceresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updategpudeviceresponse
      x-cloudstack-command: updateGpuDevice
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - createGpuDevice
      - discoverGpuDevices
      - listGpuDevices
  /updateGuestOs:
    get:
      operationId: updateGuestOs
      summary: Updates the information about Guest OS
      description: |-
        Updates the information about Guest OS

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GuestO
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateGuestOs
          default: updateGuestOs
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: UUID of the Guest OS
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
        - listOsTypes
        - updateGuestOs
      - name: details
        in: query
        description: Map of (key/value pairs). Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: forDisplay
        in: query
        description: whether this guest OS is available for end users
        schema:
          type: boolean
      - name: oscategoryid
        in: query
        description: the ID of the OS category
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.21.0
        x-cloudstack-related:
        - addOsCategory
        - listOsCategories
        - updateOsCategory
      - name: osdisplayname
        in: query
        description: Unique display name for Guest OS
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateGuestOs`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateguestosresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateguestosresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateguestosresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateguestosresponse
      x-cloudstack-command: updateGuestOs
      x-cloudstack-async: true
      x-cloudstack-since: 4.4.0
      x-cloudstack-related:
      - addGuestOs
      - listOsTypes
      x-cloudstack-jobresult-schema: '#/components/schemas/GuestO'
  /updateGuestOsMapping:
    get:
      operationId: updateGuestOsMapping
      summary: Updates the information about Guest OS to Hypervisor specific name mapping
      description: |-
        Updates the information about Guest OS to Hypervisor specific name mapping

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - GuestOsMapping
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateGuestOsMapping
          default: updateGuestOsMapping
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: UUID of the Guest OS to hypervisor name Mapping
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateGuestOsMapping
      - name: osnameforhypervisor
        in: query
        description: Hypervisor specific name for this Guest OS
        required: true
        schema:
          type: string
          maxLength: 255
      - name: osmappingcheckenabled
        in: query
        description: When set to true, checks for the correct guest os mapping name in the provided hypervisor (supports VMware and XenServer only. At least one hypervisor host with the version specified must be available. Default version will not work.)
        schema:
          type: boolean
        x-cloudstack-since: 4.19.0
      responses:
        '200':
          description: Successful invocation of `updateGuestOsMapping`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateguestosmappingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateguestosmappingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateguestosmappingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateguestosmappingresponse
      x-cloudstack-command: updateGuestOsMapping
      x-cloudstack-async: true
      x-cloudstack-since: 4.4.0
      x-cloudstack-jobresult-schema: '#/components/schemas/GuestOsMapping'
  /updateGuiTheme:
    get:
      operationId: updateGuiTheme
      summary: Updates an existing GUI theme.
      tags:
      - GuiTheme
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateGuiTheme
          default: updateGuiTheme
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the theme to be updated.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createGuiTheme
        - listGuiThemes
        - updateGuiTheme
      - name: accountids
        in: query
        description: A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
        schema:
          type: string
          maxLength: 65535
      - name: commonnames
        in: query
        description: 'A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com'
        schema:
          type: string
          maxLength: 65535
      - name: css
        in: query
        description: The CSS to be retrieved and imported into the GUI when matching the theme access configurations.
        schema:
          type: string
          maxLength: 65535
      - name: description
        in: query
        description: A description for the theme.
        schema:
          type: string
          maxLength: 4096
      - name: domainids
        in: query
        description: A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
        schema:
          type: string
          maxLength: 65535
      - name: ispublic
        in: query
        description: Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.
        schema:
          type: boolean
      - name: jsonconfiguration
        in: query
        description: The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.
        schema:
          type: string
          maxLength: 65535
      - name: loginbasedomain
        in: query
        description: The ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.
        schema:
          type: string
          maxLength: 65535
      - name: name
        in: query
        description: A name to identify the theme.
        schema:
          type: string
          maxLength: 2048
      - name: recursivedomains
        in: query
        description: Defines whether the subdomains of the informed domains are considered. Default value is false.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `updateGuiTheme`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateguithemeresponse:
                    oneOf:
                    - &id408
                      $ref: '#/components/schemas/GuiTheme'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id408
                        - type: array
                          items: *id408
                required:
                - updateguithemeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateguithemeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateguithemeresponse
      x-cloudstack-command: updateGuiTheme
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0.0
      x-cloudstack-related:
      - createGuiTheme
      - listGuiThemes
  /updateHSMProfile:
    get:
      operationId: updateHSMProfile
      summary: Updates an HSM profile
      tags:
      - HSMProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateHSMProfile
          default: updateHSMProfile
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the HSM profile
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listHSMProfiles
        - updateHSMProfile
      - name: enabled
        in: query
        description: whether the HSM profile is enabled
        schema:
          type: boolean
      - name: name
        in: query
        description: the name of the HSM profile
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateHSMProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatehsmprofileresponse:
                    oneOf:
                    - &id409
                      $ref: '#/components/schemas/HSMProfile'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id409
                        - type: array
                          items: *id409
                required:
                - updatehsmprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatehsmprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatehsmprofileresponse
      x-cloudstack-command: updateHSMProfile
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - listHSMProfiles
  /updateHost:
    get:
      operationId: updateHost
      summary: Updates a host.
      tags:
      - Host
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateHost
          default: updateHost
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the host to update
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - addHost
        - cancelHostAsDegraded
        - cancelHostMaintenance
        - declareHostAsDegraded
        - listHosts
        - prepareHostForMaintenance
        - reconnectHost
        - updateHost
      - name: allocationstate
        in: query
        description: Change resource state of host, valid values are [Enable, Disable]. Operation may failed if host in states not allowing Enable/Disable
        schema:
          type: string
          maxLength: 255
      - name: annotation
        in: query
        description: Add an annotation to this host
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.11'
      - name: cleanupexternaldetails
        in: query
        description: Optional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this host, externaldetails field ignored; if false or not set, no action)
        schema:
          type: boolean
        x-cloudstack-since: 4.22.0
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: guestosrule
        in: query
        description: the guest OS rule written in JavaScript to match with the OS of the VM.It cannot be used alongside the 'oscategoryid' parameter.
        schema:
          type: string
          maxLength: 255
      - name: hosttags
        in: query
        description: List of tags to be added to the host. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: istagarule
        in: query
        description: Whether the informed tag is a JS interpretable rule or not.
        schema:
          type: boolean
      - name: name
        in: query
        description: Change the name of host
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.15'
      - name: oscategoryid
        in: query
        description: the ID of OS category used to prioritize VMs with matching OS category during the allocation process. It cannot be used alongside the 'guestosrule' parameter.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addOsCategory
        - listOsCategories
      - name: url
        in: query
        description: 'The new URI for the secondary storage: nfs://host/path'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateHost`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatehostresponse:
                    oneOf:
                    - &id410
                      $ref: '#/components/schemas/Host'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id410
                        - type: array
                          items: *id410
                required:
                - updatehostresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatehostresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatehostresponse
      x-cloudstack-command: updateHost
      x-cloudstack-async: false
      x-cloudstack-related:
      - addBaremetalHost
      - addHost
      - cancelHostAsDegraded
      - cancelHostMaintenance
      - declareHostAsDegraded
      - listHosts
      - prepareHostForMaintenance
      - reconnectHost
  /updateHostPassword:
    get:
      operationId: updateHostPassword
      summary: Update password of a host/pool on management server.
      tags:
      - HostPassword
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateHostPassword
          default: updateHostPassword
      - $ref: '#/components/parameters/response'
      - name: password
        in: query
        description: The new password for the host/cluster
        required: true
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: The username for the host/cluster
        required: true
        schema:
          type: string
          maxLength: 255
      - name: clusterid
        in: query
        description: The cluster ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: hostid
        in: query
        description: The host ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - declareHostAsDegraded
        - reconnectHost
      - name: update_passwd_on_host
        in: query
        description: If the password should also be updated on the hosts
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `updateHostPassword`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatehostpasswordresponse:
                    oneOf:
                    - &id411
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id411
                        - type: array
                          items: *id411
                required:
                - updatehostpasswordresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatehostpasswordresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatehostpasswordresponse
      x-cloudstack-command: updateHostPassword
      x-cloudstack-async: false
  /updateHypervisorCapabilities:
    get:
      operationId: updateHypervisorCapabilities
      summary: Updates a hypervisor capabilities.
      tags:
      - HypervisorCapability
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateHypervisorCapabilities
          default: updateHypervisorCapabilities
      - $ref: '#/components/parameters/response'
      - name: hypervisor
        in: query
        description: The hypervisor for which the hypervisor capabilities are to be updated
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.1
      - name: hypervisorversion
        in: query
        description: The hypervisor version for which the hypervisor capabilities are to be updated
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.1
      - name: id
        in: query
        description: ID of the hypervisor capability
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listHypervisorCapabilities
        - updateHypervisorCapabilities
      - name: maxdatavolumeslimit
        in: query
        description: The maximum number of Data Volumes that can be attached to an Instance for this hypervisor.
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.16.0
      - name: maxguestslimit
        in: query
        description: The maximum number of Guest Instances per host for this hypervisor.
        schema:
          type: integer
          format: int64
      - name: maxhostspercluster
        in: query
        description: The maximum number of the hypervisor hosts per cluster
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.16.0
      - name: securitygroupenabled
        in: query
        description: Set true to enable security group for this hypervisor.
        schema:
          type: boolean
      - name: storagemotionenabled
        in: query
        description: Set true to enable storage motion support for this hypervisor
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      - name: vmsnapshotenabled
        in: query
        description: Set true to enable Instance Snapshots for this hypervisor
        schema:
          type: boolean
        x-cloudstack-since: 4.16.0
      responses:
        '200':
          description: Successful invocation of `updateHypervisorCapabilities`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatehypervisorcapabilitiesresponse:
                    oneOf:
                    - &id412
                      $ref: '#/components/schemas/HypervisorCapability'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id412
                        - type: array
                          items: *id412
                required:
                - updatehypervisorcapabilitiesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatehypervisorcapabilitiesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatehypervisorcapabilitiesresponse
      x-cloudstack-command: updateHypervisorCapabilities
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - listHypervisorCapabilities
  /updateImageStore:
    get:
      operationId: updateImageStore
      summary: Updates image store read-only status
      tags:
      - ImageStore
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateImageStore
          default: updateImageStore
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Image Store UUID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addImageStore
        - addImageStoreS3
        - addSecondaryStorage
        - addSwift
        - listImageStores
        - listSwifts
        - updateCloudToUseObjectStore
        - updateImageStore
      - name: capacitybytes
        in: query
        description: "The number of bytes CloudStack can use on this image storage.\n\tNOTE: this will be overwritten by the StatsCollector as soon as there is a SSVM to query the storage."
        schema:
          type: integer
          format: int64
      - name: name
        in: query
        description: The new name for the Image Store.
        schema:
          type: string
          maxLength: 255
      - name: readonly
        in: query
        description: If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `updateImageStore`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateimagestoreresponse:
                    oneOf:
                    - &id413
                      $ref: '#/components/schemas/ImageStore'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id413
                        - type: array
                          items: *id413
                required:
                - updateimagestoreresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateimagestoreresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateimagestoreresponse
      x-cloudstack-command: updateImageStore
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
      x-cloudstack-related:
      - addImageStore
      - addImageStoreS3
      - addSecondaryStorage
      - addSwift
      - listImageStores
      - listSwifts
      - updateCloudToUseObjectStore
  /updateInstanceGroup:
    get:
      operationId: updateInstanceGroup
      summary: Updates an Instance group
      tags:
      - InstanceGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateInstanceGroup
          default: updateInstanceGroup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Instance group ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateInstanceGroup
      - name: name
        in: query
        description: New Instance group name
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateInstanceGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateinstancegroupresponse:
                    oneOf:
                    - &id414
                      $ref: '#/components/schemas/InstanceGroup'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id414
                        - type: array
                          items: *id414
                required:
                - updateinstancegroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateinstancegroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateinstancegroupresponse
      x-cloudstack-command: updateInstanceGroup
      x-cloudstack-async: false
  /updateIpAddress:
    get:
      operationId: updateIpAddress
      summary: Updates an IP address
      description: |-
        Updates an IP address

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - IpAddress
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateIpAddress
          default: updateIpAddress
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the public IP address to update
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - associateIpAddress
        - listPublicIpAddresses
        - updateIpAddress
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the IP to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateIpAddress`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateipaddressresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateipaddressresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateipaddressresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateipaddressresponse
      x-cloudstack-command: updateIpAddress
      x-cloudstack-async: true
      x-cloudstack-related:
      - associateIpAddress
      - listPublicIpAddresses
      x-cloudstack-jobresult-schema: '#/components/schemas/IpAddress'
  /updateIpv4SubnetForZone:
    get:
      operationId: updateIpv4SubnetForZone
      summary: Updates an existing IPv4 subnet for a zone.
      description: |-
        Updates an existing IPv4 subnet for a zone.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Ipv4SubnetForZone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateIpv4SubnetForZone
          default: updateIpv4SubnetForZone
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of the guest network IPv4 subnet
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpv4SubnetForZone
        - dedicateIpv4SubnetForZone
        - listIpv4SubnetsForZone
        - releaseIpv4SubnetForZone
        - updateIpv4SubnetForZone
      - name: subnet
        in: query
        description: The new CIDR of the IPv4 subnet.
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateIpv4SubnetForZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateipv4subnetforzoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateipv4subnetforzoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateipv4subnetforzoneresponse
      x-cloudstack-command: updateIpv4SubnetForZone
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createIpv4SubnetForZone
      - dedicateIpv4SubnetForZone
      - listIpv4SubnetsForZone
      - releaseIpv4SubnetForZone
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv4SubnetForZone'
  /updateIpv6FirewallRule:
    get:
      operationId: updateIpv6FirewallRule
      summary: Updates Ipv6 firewall rule with specified ID
      description: |-
        Updates Ipv6 firewall rule with specified ID

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Ipv6FirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateIpv6FirewallRule
          default: updateIpv6FirewallRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the IPv6 firewall rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: cidrlist
        in: query
        description: The cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: endport
        in: query
        description: The ending port of Ipv6 firewall rule
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the Ipv6 firewall rule to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: icmpcode
        in: query
        description: Error code for this ICMP message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: Type of the ICMP message being sent
        schema:
          type: integer
          format: int32
      - name: protocol
        in: query
        description: The protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number
        schema:
          type: string
          maxLength: 255
      - name: startport
        in: query
        description: The starting port of Ipv6 firewall rule
        schema:
          type: integer
          format: int32
      - name: traffictype
        in: query
        description: The traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateIpv6FirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateipv6firewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateipv6firewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateipv6firewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateipv6firewallruleresponse
      x-cloudstack-command: updateIpv6FirewallRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - createIpForwardingRule
      - createPortForwardingRule
      - listRoutingFirewallRules
      - updatePortForwardingRule
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv6FirewallRule'
  /updateIso:
    get:
      operationId: updateIso
      summary: Updates an ISO file.
      tags:
      - Iso
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateIso
          default: updateIso
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the image file
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: arch
        in: query
        description: 'the CPU arch of the template/ISO. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: bootable
        in: query
        description: True if image is bootable, false otherwise; available only for updateIso API
        schema:
          type: boolean
      - name: cleanupdetails
        in: query
        description: Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)
        schema:
          type: boolean
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: displaytext
        in: query
        description: The display text of the image
        schema:
          type: string
          maxLength: 4096
      - name: forceupdateostype
        in: query
        description: 'Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.'
        schema:
          type: boolean
        x-cloudstack-since: '4.21'
      - name: format
        in: query
        description: The format for the image
        schema:
          type: string
          maxLength: 255
      - name: isdynamicallyscalable
        in: query
        description: True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
        schema:
          type: boolean
      - name: isrouting
        in: query
        description: True if the Template type is routing i.e., if Template is used to deploy router
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the image file
        schema:
          type: string
          maxLength: 251
      - name: ostypeid
        in: query
        description: The ID of the OS type that best represents the OS of this image.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
      - name: passwordenabled
        in: query
        description: True if the image supports the password reset feature; default is false
        schema:
          type: boolean
      - name: requireshvm
        in: query
        description: True if the Template requires HVM, false otherwise; available only for updateTemplate API
        schema:
          type: boolean
      - name: sortkey
        in: query
        description: Sort key of the Template, integer
        schema:
          type: integer
          format: int32
      - name: sshkeyenabled
        in: query
        description: True if the Template supports the SSHkey upload feature; default is false
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `updateIso`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateisoresponse:
                    oneOf:
                    - &id415
                      $ref: '#/components/schemas/Template'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id415
                        - type: array
                          items: *id415
                required:
                - updateisoresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateisoresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateisoresponse
      x-cloudstack-command: updateIso
      x-cloudstack-async: false
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - prepareTemplate
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateTemplate
      - updateVnfTemplate
  /updateIsoPermissions:
    get:
      operationId: updateIsoPermissions
      summary: Updates ISO permissions
      tags:
      - IsoPermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateIsoPermissions
          default: updateIsoPermissions
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The Template ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: accounts
        in: query
        description: A comma delimited list of Accounts within caller's domain. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: isextractable
        in: query
        description: True if the Template/ISO is extractable, false otherwise. Can be set only by root admin
        schema:
          type: boolean
      - name: isfeatured
        in: query
        description: True for featured Template/ISO, false otherwise
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: True for public Template/ISO, false for private Templates/ISOs
        schema:
          type: boolean
      - name: op
        in: query
        description: Permission operator (add, remove, reset)
        schema:
          type: string
          maxLength: 255
      - name: projectids
        in: query
        description: A comma delimited list of projects. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - activateProject
        - createProject
      responses:
        '200':
          description: Successful invocation of `updateIsoPermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateisopermissionsresponse:
                    oneOf:
                    - &id416
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id416
                        - type: array
                          items: *id416
                required:
                - updateisopermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateisopermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateisopermissionsresponse
      x-cloudstack-command: updateIsoPermissions
      x-cloudstack-async: false
  /updateKMSKey:
    get:
      operationId: updateKMSKey
      summary: Updates KMS key name, description, or enabled status
      tags:
      - KMSKey
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateKMSKey
          default: updateKMSKey
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The UUID of the KMS key to update
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateKMSKey
      - name: description
        in: query
        description: New description for the key
        schema:
          type: string
          maxLength: 255
      - name: enabled
        in: query
        description: whether the key should be enabled
        schema:
          type: boolean
      - name: name
        in: query
        description: New name for the key
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateKMSKey`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatekmskeyresponse:
                    oneOf:
                    - &id417
                      $ref: '#/components/schemas/KMSKey'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id417
                        - type: array
                          items: *id417
                required:
                - updatekmskeyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatekmskeyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatekmskeyresponse
      x-cloudstack-command: updateKMSKey
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /updateKubernetesClusterAffinityGroups:
    get:
      operationId: updateKubernetesClusterAffinityGroups
      summary: Updates the affinity group mappings for a stopped Kubernetes cluster
      tags:
      - AffinityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateKubernetesClusterAffinityGroups
          default: updateKubernetesClusterAffinityGroups
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
      - name: nodeaffinitygroups
        in: query
        description: Node Type to Affinity Group ID mapping. VMs of each node type will be added to the specified affinity group. Map parameter. CloudStack expects it index-encoded as `nodeaffinitygroups[0].key=k&nodeaffinitygroups[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.23.0
      responses:
        '200':
          description: Successful invocation of `updateKubernetesClusterAffinityGroups`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatekubernetesclusteraffinitygroupsresponse:
                    oneOf:
                    - &id418
                      $ref: '#/components/schemas/KubernetesCluster'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id418
                        - type: array
                          items: *id418
                required:
                - updatekubernetesclusteraffinitygroupsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatekubernetesclusteraffinitygroupsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatekubernetesclusteraffinitygroupsresponse
      x-cloudstack-command: updateKubernetesClusterAffinityGroups
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - startKubernetesCluster
  /updateKubernetesSupportedVersion:
    get:
      operationId: updateKubernetesSupportedVersion
      summary: Update a supported Kubernetes version
      tags:
      - KubernetesSupportedVersion
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateKubernetesSupportedVersion
          default: updateKubernetesSupportedVersion
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes supported version
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - getUploadParamsForKubernetesSupportedVersion
        - listKubernetesSupportedVersions
        - updateKubernetesSupportedVersion
      - name: state
        in: query
        description: The enabled or disabled state of the Kubernetes supported version
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateKubernetesSupportedVersion`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatekubernetessupportedversionresponse:
                    oneOf:
                    - &id419
                      $ref: '#/components/schemas/KubernetesSupportedVersion'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id419
                        - type: array
                          items: *id419
                required:
                - updatekubernetessupportedversionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatekubernetessupportedversionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatekubernetessupportedversionresponse
      x-cloudstack-command: updateKubernetesSupportedVersion
      x-cloudstack-async: false
      x-cloudstack-related:
      - getUploadParamsForKubernetesSupportedVersion
      - listKubernetesSupportedVersions
  /updateLBHealthCheckPolicy:
    get:
      operationId: updateLBHealthCheckPolicy
      summary: Updates load balancer health check policy
      description: |-
        Updates load balancer health check policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LBHealthCheckPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateLBHealthCheckPolicy
          default: updateLBHealthCheckPolicy
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of load balancer health check policy
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createLBHealthCheckPolicy
        - listLBHealthCheckPolicies
        - updateLBHealthCheckPolicy
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the policy to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateLBHealthCheckPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatelbhealthcheckpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatelbhealthcheckpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatelbhealthcheckpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatelbhealthcheckpolicyresponse
      x-cloudstack-command: updateLBHealthCheckPolicy
      x-cloudstack-async: true
      x-cloudstack-since: '4.4'
      x-cloudstack-related:
      - createLBHealthCheckPolicy
      - listLBHealthCheckPolicies
      x-cloudstack-jobresult-schema: '#/components/schemas/LBHealthCheckPolicy'
  /updateLBStickinessPolicy:
    get:
      operationId: updateLBStickinessPolicy
      summary: Updates load balancer stickiness policy
      description: |-
        Updates load balancer stickiness policy

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LBStickinessPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateLBStickinessPolicy
          default: updateLBStickinessPolicy
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of lb stickiness policy
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createLBStickinessPolicy
        - updateLBStickinessPolicy
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the policy to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateLBStickinessPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatelbstickinesspolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatelbstickinesspolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatelbstickinesspolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatelbstickinesspolicyresponse
      x-cloudstack-command: updateLBStickinessPolicy
      x-cloudstack-async: true
      x-cloudstack-since: '4.4'
      x-cloudstack-related:
      - createLBStickinessPolicy
      x-cloudstack-jobresult-schema: '#/components/schemas/LBStickinessPolicy'
  /updateLoadBalancer:
    get:
      operationId: updateLoadBalancer
      summary: Updates an internal load balancer
      description: |-
        Updates an internal load balancer

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancer
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateLoadBalancer
          default: updateLoadBalancer
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the load balancer
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listIpv6FirewallRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
        - updateRoutingFirewallRule
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateLoadBalancer`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateloadbalancerresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateloadbalancerresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateloadbalancerresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateloadbalancerresponse
      x-cloudstack-command: updateLoadBalancer
      x-cloudstack-async: true
      x-cloudstack-since: 4.4.0
      x-cloudstack-related:
      - createLoadBalancer
      - listLoadBalancers
      x-cloudstack-jobresult-schema: '#/components/schemas/LoadBalancer'
  /updateLoadBalancerRule:
    get:
      operationId: updateLoadBalancerRule
      summary: Updates load balancer
      description: |-
        Updates load balancer

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - LoadBalancerRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateLoadBalancerRule
          default: updateLoadBalancerRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the load balancer rule to update
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: algorithm
        in: query
        description: Load balancer algorithm (source, roundrobin, leastconn)
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: the cidr list to forward traffic from. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-since: '4.22'
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: description
        in: query
        description: The description of the load balancer rule
        schema:
          type: string
          maxLength: 4096
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: name
        in: query
        description: The name of the load balancer rule
        schema:
          type: string
          maxLength: 255
      - name: protocol
        in: query
        description: The protocol for the LB
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateLoadBalancerRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateloadbalancerruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateloadbalancerruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateloadbalancerruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateloadbalancerruleresponse
      x-cloudstack-command: updateLoadBalancerRule
      x-cloudstack-async: true
      x-cloudstack-related:
      - listLoadBalancerRules
      x-cloudstack-jobresult-schema: '#/components/schemas/LoadBalancerRule'
  /updateNetwork:
    get:
      operationId: updateNetwork
      summary: Updates a network
      description: |-
        Updates a network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Network
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateNetwork
          default: updateNetwork
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetwork
        - listBrocadeVcsDeviceNetworks
        - listNetscalerLoadBalancerNetworks
        - listNetworks
        - listPaloAltoFirewallNetworks
        - migrateNetwork
        - updateNetwork
      - name: changecidr
        in: query
        description: Force update even if CIDR type is different
        schema:
          type: boolean
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: displaynetwork
        in: query
        description: An optional field, whether to the display the network to the end User or not.
        schema:
          type: boolean
      - name: displaytext
        in: query
        description: The new display text for the network
        schema:
          type: string
          maxLength: 255
      - name: dns1
        in: query
        description: The first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: dns2
        in: query
        description: The second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: forced
        in: query
        description: Setting this to true will cause a forced network update,
        schema:
          type: boolean
      - name: guestvmcidr
        in: query
        description: CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR
        schema:
          type: string
          maxLength: 255
      - name: hideipaddressusage
        in: query
        description: When true IP address usage for the Network will not be exported by the listUsageRecords API
        schema:
          type: boolean
      - name: ip6dns1
        in: query
        description: The first IPv6 DNS for the network. Empty string will update the first IPv6 DNS with the value from the zone
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: ip6dns2
        in: query
        description: The second IPv6 DNS for the network. Empty string will update the second IPv6 DNS with the value from the zone
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.18.0
      - name: keepmacaddressonpublicnic
        in: query
        description: Indicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have  a new MAC address.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: name
        in: query
        description: The new name for the network
        schema:
          type: string
          maxLength: 255
      - name: networkdomain
        in: query
        description: Network domain
        schema:
          type: string
          maxLength: 255
      - name: networkofferingid
        in: query
        description: Network offering ID
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkOffering
        - listNetworkOfferings
        - updateNetworkOffering
      - name: privatemtu
        in: query
        description: MTU to be configured on the network VR's public facing interfaces
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.18.0
      - name: publicmtu
        in: query
        description: MTU to be configured on the network VR's public facing interfaces
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.18.0
      - name: sourcenatipaddress
        in: query
        description: IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.19'
      - name: updateinsequence
        in: query
        description: If true, we will update the routers one after the other. applicable only for redundant router based networks using virtual router as provider
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `updateNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatenetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatenetworkresponse
      x-cloudstack-command: updateNetwork
      x-cloudstack-async: true
      x-cloudstack-related:
      - createNetwork
      - listBrocadeVcsDeviceNetworks
      - listNetscalerLoadBalancerNetworks
      - listNetworks
      - listPaloAltoFirewallNetworks
      - migrateNetwork
      - updateNetwork
      x-cloudstack-jobresult-schema: '#/components/schemas/Network'
  /updateNetworkACLItem:
    get:
      operationId: updateNetworkACLItem
      summary: Updates ACL item with specified ID
      description: |-
        Updates ACL item with specified ID

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkACLItem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateNetworkACLItem
          default: updateNetworkACLItem
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network ACL item
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - moveNetworkAclItem
        - updateNetworkACLItem
      - name: action
        in: query
        description: ACL entry action, allow or deny
        schema:
          type: string
          maxLength: 255
      - name: cidrlist
        in: query
        description: The CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,). List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: endport
        in: query
        description: The ending port of ACL
        schema:
          type: integer
          format: int32
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: icmpcode
        in: query
        description: Error code for this ICMP message
        schema:
          type: integer
          format: int32
      - name: icmptype
        in: query
        description: Type of the ICMP message being sent
        schema:
          type: integer
          format: int32
      - name: number
        in: query
        description: The Network of the Instance the ACL will be created for
        schema:
          type: integer
          format: int32
      - name: partialupgrade
        in: query
        description: Indicates if the ACL rule is to be updated partially (merging the parameters sent with current configuration) or completely (disconsidering all of the current configurations). The default value is 'true'.
        schema:
          type: boolean
      - name: protocol
        in: query
        description: The protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number
        schema:
          type: string
          maxLength: 255
      - name: reason
        in: query
        description: A description indicating why the ACL rule is required.
        schema:
          type: string
          maxLength: 255
      - name: startport
        in: query
        description: The starting port of ACL
        schema:
          type: integer
          format: int32
      - name: traffictype
        in: query
        description: The traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateNetworkACLItem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkaclitemresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatenetworkaclitemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkaclitemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatenetworkaclitemresponse
      x-cloudstack-command: updateNetworkACLItem
      x-cloudstack-async: true
      x-cloudstack-related:
      - moveNetworkAclItem
      x-cloudstack-jobresult-schema: '#/components/schemas/NetworkACL'
  /updateNetworkACLList:
    get:
      operationId: updateNetworkACLList
      summary: Updates Network ACL list
      description: |-
        Updates Network ACL list

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkACLList
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateNetworkACLList
          default: updateNetworkACLList
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the network ACL
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkACLList
        - listNetworkACLLists
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: description
        in: query
        description: Description of the network ACL list
        schema:
          type: string
          maxLength: 255
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the list to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: name
        in: query
        description: Name of the network ACL list
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateNetworkACLList`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkacllistresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatenetworkacllistresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkacllistresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatenetworkacllistresponse
      x-cloudstack-command: updateNetworkACLList
      x-cloudstack-async: true
      x-cloudstack-since: '4.4'
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /updateNetworkOffering:
    get:
      operationId: updateNetworkOffering
      summary: Updates a network offering.
      tags:
      - NetworkOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateNetworkOffering
          default: updateNetworkOffering
      - $ref: '#/components/parameters/response'
      - name: availability
        in: query
        description: The availability of network offering. The value is Required makes this network offering default for Guest Virtual Networks. Only one network offering can have the value Required
        schema:
          type: string
          maxLength: 255
      - name: displaytext
        in: query
        description: The display text of the network offering
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s) as comma separated string, public for public offerings
        schema:
          type: string
          maxLength: 4096
      - name: id
        in: query
        description: The ID of the network offering
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createNetworkOffering
        - listNetworkOfferings
        - updateNetworkOffering
      - name: keepaliveenabled
        in: query
        description: If true keepalive will be turned on in the loadbalancer. At the time of writing this has only an effect on haproxy; the mode http and httpclose options are unset in the haproxy conf file.
        schema:
          type: boolean
      - name: maxconnections
        in: query
        description: Maximum number of concurrent connections supported by the network offering
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: The name of the network offering
        schema:
          type: string
          maxLength: 255
      - name: sortkey
        in: query
        description: Sort key of the network offering, integer
        schema:
          type: integer
          format: int32
      - name: state
        in: query
        description: Update state for the network offering
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: The tags for the network offering.
        schema:
          type: string
          maxLength: 4096
      - name: zoneid
        in: query
        description: The ID of the containing zone(s) as comma separated string, all for all zones offerings
        schema:
          type: string
          maxLength: 4096
        x-cloudstack-since: '4.13'
      responses:
        '200':
          description: Successful invocation of `updateNetworkOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkofferingresponse:
                    oneOf:
                    - &id420
                      $ref: '#/components/schemas/NetworkOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id420
                        - type: array
                          items: *id420
                required:
                - updatenetworkofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatenetworkofferingresponse
      x-cloudstack-command: updateNetworkOffering
      x-cloudstack-async: false
      x-cloudstack-related:
      - createNetworkOffering
      - listNetworkOfferings
  /updateNetworkServiceProvider:
    get:
      operationId: updateNetworkServiceProvider
      summary: Updates a network serviceProvider of a physical network
      description: |-
        Updates a network serviceProvider of a physical network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - NetworkServiceProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateNetworkServiceProvider
          default: updateNetworkServiceProvider
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Network service provider ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNetworkServiceProvider
        - listNetworkServiceProviders
        - updateNetworkServiceProvider
      - name: servicelist
        in: query
        description: The list of services to be enabled for this physical network service provider. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: state
        in: query
        description: Enabled/Disabled/Shutdown the physical network service provider
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateNetworkServiceProvider`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkserviceproviderresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatenetworkserviceproviderresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatenetworkserviceproviderresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatenetworkserviceproviderresponse
      x-cloudstack-command: updateNetworkServiceProvider
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - addNetworkServiceProvider
      - listNetworkServiceProviders
      x-cloudstack-jobresult-schema: '#/components/schemas/NetworkServiceProvider'
  /updateOauthProvider:
    get:
      operationId: updateOauthProvider
      summary: Updates the registered OAuth provider details
      tags:
      - OauthProvider
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateOauthProvider
          default: updateOauthProvider
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: id of the OAuth provider to be updated
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateOauthProvider
      - name: authorizeurl
        in: query
        description: Authorize URL pre-registered in the specific OAuth provider
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: clientid
        in: query
        description: Client ID pre-registered in the specific OAuth provider
        schema:
          type: string
          maxLength: 255
      - name: description
        in: query
        description: Description of the OAuth Provider
        schema:
          type: string
          maxLength: 255
      - name: domain
        in: query
        description: Domain path to reassign this OAuth provider to. Ignored when Domain ID is passed. If neither is provided, the current domain assignment is kept.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: domainid
        in: query
        description: Domain ID to reassign this OAuth provider to. If not provided, the current domain assignment is kept.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: enabled
        in: query
        description: OAuth provider will be enabled or disabled based on this value
        schema:
          type: boolean
      - name: redirecturi
        in: query
        description: Redirect URI pre-registered in the specific OAuth provider
        schema:
          type: string
          maxLength: 255
      - name: secretkey
        in: query
        description: Secret Key pre-registered in the specific OAuth provider
        schema:
          type: string
          maxLength: 255
      - name: tokenurl
        in: query
        description: Token URL pre-registered in the specific OAuth provider
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      responses:
        '200':
          description: Successful invocation of `updateOauthProvider`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateoauthproviderresponse:
                    oneOf:
                    - &id421
                      $ref: '#/components/schemas/OauthProvider'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id421
                        - type: array
                          items: *id421
                required:
                - updateoauthproviderresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateoauthproviderresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateoauthproviderresponse
      x-cloudstack-command: updateOauthProvider
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /updateObjectStoragePool:
    get:
      operationId: updateObjectStoragePool
      summary: Updates object storage pool
      tags:
      - ObjectStoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateObjectStoragePool
          default: updateObjectStoragePool
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Object Store ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addObjectStoragePool
        - updateObjectStoragePool
      - name: name
        in: query
        description: the name for the object store
        schema:
          type: string
          maxLength: 255
      - name: size
        in: query
        description: the total size of the object store in GiB. Used for tracking capacity and sending alerts. Set to 0 to stop tracking.
        schema:
          type: integer
          format: int64
        x-cloudstack-since: '4.21'
      - name: url
        in: query
        description: the url for the object store
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateObjectStoragePool`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateobjectstoragepoolresponse:
                    oneOf:
                    - &id422
                      $ref: '#/components/schemas/ObjectStoragePool'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id422
                        - type: array
                          items: *id422
                required:
                - updateobjectstoragepoolresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateobjectstoragepoolresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateobjectstoragepoolresponse
      x-cloudstack-command: updateObjectStoragePool
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - addObjectStoragePool
  /updateOsCategory:
    get:
      operationId: updateOsCategory
      summary: Updates an OS category
      tags:
      - OsCategory
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateOsCategory
          default: updateOsCategory
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the OS category
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addOsCategory
        - listOsCategories
        - updateOsCategory
      - name: isfeatured
        in: query
        description: Whether the category is featured or not
        schema:
          type: boolean
      - name: name
        in: query
        description: Name for the OS category
        schema:
          type: string
          maxLength: 255
      - name: sortkey
        in: query
        description: sort key of the OS category for listing
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `updateOsCategory`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateoscategoryresponse:
                    oneOf:
                    - &id423
                      $ref: '#/components/schemas/OsCategory'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id423
                        - type: array
                          items: *id423
                required:
                - updateoscategoryresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateoscategoryresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateoscategoryresponse
      x-cloudstack-command: updateOsCategory
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - addOsCategory
      - listOsCategories
  /updatePhysicalNetwork:
    get:
      operationId: updatePhysicalNetwork
      summary: Updates a physical network
      description: |-
        Updates a physical network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PhysicalNetwork
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updatePhysicalNetwork
          default: updatePhysicalNetwork
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Physical Network ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updatePhysicalNetwork
      - name: networkspeed
        in: query
        description: The speed for the physical Network[1G/10G]
        schema:
          type: string
          maxLength: 255
      - name: state
        in: query
        description: Enabled/Disabled
        schema:
          type: string
          maxLength: 255
      - name: tags
        in: query
        description: Tag the physical Network. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: vlan
        in: query
        description: The VLAN for the physical Network
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updatePhysicalNetwork`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatephysicalnetworkresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatephysicalnetworkresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatephysicalnetworkresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatephysicalnetworkresponse
      x-cloudstack-command: updatePhysicalNetwork
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/PhysicalNetwork'
  /updatePod:
    get:
      operationId: updatePod
      summary: Updates a Pod.
      tags:
      - Pod
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updatePod
          default: updatePod
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Pod
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: allocationstate
        in: query
        description: Allocation state of this cluster for allocation of new resources
        schema:
          type: string
          maxLength: 255
      - name: endip
        in: query
        description: The ending IP address for the Pod
        schema:
          type: string
          maxLength: 255
      - name: gateway
        in: query
        description: The gateway for the Pod
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the Pod
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The netmask of the Pod
        schema:
          type: string
          maxLength: 255
      - name: startip
        in: query
        description: The starting IP address for the Pod
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updatePod`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatepodresponse:
                    oneOf:
                    - &id424
                      $ref: '#/components/schemas/Pod'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id424
                        - type: array
                          items: *id424
                required:
                - updatepodresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatepodresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatepodresponse
      x-cloudstack-command: updatePod
      x-cloudstack-async: false
      x-cloudstack-related:
      - createManagementNetworkIpRange
      - createPod
      - listPods
  /updatePodManagementNetworkIpRange:
    get:
      operationId: updatePodManagementNetworkIpRange
      summary: Updates a management network IP range.
      description: |-
        Updates a management network IP range. Only allowed when no IPs are allocated.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PodManagementNetworkIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updatePodManagementNetworkIpRange
          default: updatePodManagementNetworkIpRange
      - $ref: '#/components/parameters/response'
      - name: currentendip
        in: query
        description: The current ending IP address.
        required: true
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - listPods
      - name: currentstartip
        in: query
        description: The current starting IP address.
        required: true
        schema:
          type: string
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - listPods
      - name: podid
        in: query
        description: UUID of POD, where the IP range belongs to.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - listPods
      - name: newendip
        in: query
        description: The new ending IP address.
        schema:
          type: string
          maxLength: 255
      - name: newstartip
        in: query
        description: The new starting IP address.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updatePodManagementNetworkIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatepodmanagementnetworkiprangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatepodmanagementnetworkiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatepodmanagementnetworkiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatepodmanagementnetworkiprangeresponse
      x-cloudstack-command: updatePodManagementNetworkIpRange
      x-cloudstack-async: true
      x-cloudstack-since: 4.16.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /updatePortForwardingRule:
    get:
      operationId: updatePortForwardingRule
      summary: Updates a port forwarding rule.
      description: |-
        Updates a port forwarding rule. Only the private port and the  Instance can be updated.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - PortForwardingRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updatePortForwardingRule
          default: updatePortForwardingRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the port forwarding rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.4'
        x-cloudstack-related:
        - updatePortForwardingRule
      - name: cidrlist
        in: query
        description: the source CIDR list to allow traffic from; all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,). This param will be used only for VPC tiers. By default, all CIDRs are allowed. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the rule to the end user or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: privateendport
        in: query
        description: The private end port of the port forwarding rule
        schema:
          type: integer
          format: int32
      - name: privateport
        in: query
        description: The private start port of the port forwarding rule
        schema:
          type: integer
          format: int32
      - name: virtualmachineid
        in: query
        description: The ID of the  Instance for the port forwarding rule
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: vmguestip
        in: query
        description: Instance guest NIC Secondary IP address for the port forwarding rule
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.5'
      responses:
        '200':
          description: Successful invocation of `updatePortForwardingRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateportforwardingruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateportforwardingruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateportforwardingruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateportforwardingruleresponse
      x-cloudstack-command: updatePortForwardingRule
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv6FirewallRule'
  /updateProject:
    get:
      operationId: updateProject
      summary: Updates a project
      description: |-
        Updates a project

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Project
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateProject
          default: updateProject
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the project to be modified
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
        - updateProject
      - name: account
        in: query
        description: New Admin Account for the project
        schema:
          type: string
          maxLength: 255
      - name: displaytext
        in: query
        description: Display text of the project
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name of the project
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      - name: roletype
        in: query
        description: 'Account level role to be assigned to the User/Account : Admin/Regular'
        schema:
          type: string
          maxLength: 255
      - name: swapowner
        in: query
        description: When true, it swaps ownership with the Account/User provided. Ideally to be used when a single project administrator is present. In case of multiple project admins, swapowner is to be set to false,to promote or demote the user/account based on the roleType (Regular or Admin) provided. Defaults to true
        schema:
          type: boolean
      - name: userid
        in: query
        description: ID of the User to be promoted/demoted
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
      responses:
        '200':
          description: Successful invocation of `updateProject`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateprojectresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateprojectresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateprojectresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateprojectresponse
      x-cloudstack-command: updateProject
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - activateProject
      - createProject
      - suspendProject
      x-cloudstack-jobresult-schema: '#/components/schemas/Project'
  /updateProjectInvitation:
    get:
      operationId: updateProjectInvitation
      summary: Accepts or declines project invitation
      description: |-
        Accepts or declines project invitation

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - ProjectInvitation
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateProjectInvitation
          default: updateProjectInvitation
      - $ref: '#/components/parameters/response'
      - name: projectid
        in: query
        description: ID of the project to join
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      - name: accept
        in: query
        description: If true, accept the invitation, decline if false. True by default
        schema:
          type: boolean
      - name: account
        in: query
        description: Account that is joining the project
        schema:
          type: string
          maxLength: 255
      - name: token
        in: query
        description: List invitations for specified account; this parameter has to be specified with domainId
        schema:
          type: string
          maxLength: 255
      - name: userid
        in: query
        description: User UUID, required for adding account from external provisioning system
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
      responses:
        '200':
          description: Successful invocation of `updateProjectInvitation`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateprojectinvitationresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateprojectinvitationresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateprojectinvitationresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateprojectinvitationresponse
      x-cloudstack-command: updateProjectInvitation
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-jobresult-schema: '#/components/schemas/SuccessResult'
  /updateProjectRole:
    get:
      operationId: updateProjectRole
      summary: Creates a Project role
      tags:
      - ProjectRole
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateProjectRole
          default: updateProjectRole
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the Project role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateProjectRole
      - name: projectid
        in: query
        description: ID of project where role is being created
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: description
        in: query
        description: The description of the Project role
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Creates a project role with this unique name
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateProjectRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateprojectroleresponse:
                    oneOf:
                    - &id425
                      $ref: '#/components/schemas/ProjectRole'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id425
                        - type: array
                          items: *id425
                required:
                - updateprojectroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateprojectroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateprojectroleresponse
      x-cloudstack-command: updateProjectRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
  /updateProjectRolePermission:
    get:
      operationId: updateProjectRolePermission
      summary: Updates a project role permission and/or order
      tags:
      - ProjectRolePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateProjectRolePermission
          default: updateProjectRolePermission
      - $ref: '#/components/parameters/response'
      - name: projectid
        in: query
        description: ID of project where project role permission is to be updated
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - suspendProject
      - name: projectroleid
        in: query
        description: ID of the project role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectRoles
        - updateProjectRole
      - name: permission
        in: query
        description: 'Rule permission, can be: allow or deny'
        schema:
          type: string
          maxLength: 255
      - name: projectrolepermissionid
        in: query
        description: Project Role permission rule id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listProjectRolePermissions
      - name: ruleorder
        in: query
        description: ID of the parent role permission, use 0 to move this rule at the top of the list. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - listProjectRolePermissions
      responses:
        '200':
          description: Successful invocation of `updateProjectRolePermission`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateprojectrolepermissionresponse:
                    oneOf:
                    - &id426
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id426
                        - type: array
                          items: *id426
                required:
                - updateprojectrolepermissionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateprojectrolepermissionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateprojectrolepermissionresponse
      x-cloudstack-command: updateProjectRolePermission
      x-cloudstack-async: false
      x-cloudstack-since: 4.15.0
  /updateQuarantinedIp:
    get:
      operationId: updateQuarantinedIp
      summary: Updates the quarantine end date for the given public IP address.
      tags:
      - QuarantinedIp
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateQuarantinedIp
          default: updateQuarantinedIp
      - $ref: '#/components/parameters/response'
      - name: enddate
        in: query
        description: The date when the quarantine will no longer be active. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        required: true
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: id
        in: query
        description: The ID of the public IP address in active quarantine.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateQuarantinedIp
      - name: ipaddress
        in: query
        description: The public IP address in active quarantine. Either the IP address is informed, or the ID of the IP address in quarantine.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateQuarantinedIp`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatequarantinedipresponse:
                    oneOf:
                    - &id427
                      $ref: '#/components/schemas/QuarantinedIp'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id427
                        - type: array
                          items: *id427
                required:
                - updatequarantinedipresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatequarantinedipresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatequarantinedipresponse
      x-cloudstack-command: updateQuarantinedIp
      x-cloudstack-async: false
      x-cloudstack-since: '4.19'
  /updateRegion:
    get:
      operationId: updateRegion
      summary: Updates a region
      tags:
      - Region
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateRegion
          default: updateRegion
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Id of region to update
        required: true
        schema:
          type: integer
          format: int32
      - name: endpoint
        in: query
        description: Updates region with this end point
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Updates region with this name
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateRegion`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateregionresponse:
                    oneOf:
                    - &id428
                      $ref: '#/components/schemas/Region'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id428
                        - type: array
                          items: *id428
                required:
                - updateregionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateregionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateregionresponse
      x-cloudstack-command: updateRegion
      x-cloudstack-async: false
  /updateRegisteredExtension:
    get:
      operationId: updateRegisteredExtension
      summary: Update details for an extension registered with a resource
      tags:
      - Extension
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateRegisteredExtension
          default: updateRegisteredExtension
      - $ref: '#/components/parameters/response'
      - name: extensionid
        in: query
        description: ID of the extension
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createExtension
        - deleteExtension
        - listExtensions
        - registerExtension
        - unregisterExtension
        - updateExtension
        - updateRegisteredExtension
      - name: resourceid
        in: query
        description: ID of the resource where the extension is registered
        required: true
        schema:
          type: string
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      - name: cleanupdetails
        in: query
        description: Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this registration, details field ignored; if false or not set, details can be updated through details map)
        schema:
          type: boolean
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `updateRegisteredExtension`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateregisteredextensionresponse:
                    oneOf:
                    - &id429
                      $ref: '#/components/schemas/Extension'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id429
                        - type: array
                          items: *id429
                required:
                - updateregisteredextensionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateregisteredextensionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateregisteredextensionresponse
      x-cloudstack-command: updateRegisteredExtension
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
      x-cloudstack-related:
      - createExtension
      - deleteExtension
      - listExtensions
      - registerExtension
      - unregisterExtension
      - updateExtension
  /updateRemoteAccessVpn:
    get:
      operationId: updateRemoteAccessVpn
      summary: Updates remote access VPN
      description: |-
        Updates remote access VPN

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - RemoteAccessVpn
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateRemoteAccessVpn
          default: updateRemoteAccessVpn
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the remote access VPN
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRemoteAccessVpn
        - listRemoteAccessVpns
        - updateRemoteAccessVpn
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the VPN to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateRemoteAccessVpn`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateremoteaccessvpnresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateremoteaccessvpnresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateremoteaccessvpnresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateremoteaccessvpnresponse
      x-cloudstack-command: updateRemoteAccessVpn
      x-cloudstack-async: true
      x-cloudstack-since: '4.4'
      x-cloudstack-related:
      - createRemoteAccessVpn
      - listRemoteAccessVpns
      x-cloudstack-jobresult-schema: '#/components/schemas/RemoteAccessVpn'
  /updateResourceCount:
    get:
      operationId: updateResourceCount
      summary: Recalculate and update resource count for an account or domain.
      description: Recalculate and update resource count for an account or domain. This also executes some cleanup tasks before calculating resource counts.
      tags:
      - ResourceCount
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateResourceCount
          default: updateResourceCount
      - $ref: '#/components/parameters/response'
      - name: domainid
        in: query
        description: If account parameter specified then updates resource counts for a specified account in this domain else update resource counts for all accounts & child domains in specified domain.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listDomains
      - name: account
        in: query
        description: Update resource count for a specified account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: Update resource limits for project
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: resourcetype
        in: query
        description: Type of resource to update. If specifies valid values are 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 and 11. If not specified will update all resource counts0 - Instance. Number of Instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of Snapshots a user can create. 4 - Template. Number of Templates that a user can register/create. 5 - Project. Number of projects that a user can create. 6 - Network. Number of guest network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use.
        schema:
          type: integer
          format: int32
      - name: tag
        in: query
        description: Tag for the resource type
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      responses:
        '200':
          description: Successful invocation of `updateResourceCount`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateresourcecountresponse:
                    oneOf:
                    - &id430
                      $ref: '#/components/schemas/ResourceCount'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id430
                        - type: array
                          items: *id430
                required:
                - updateresourcecountresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateresourcecountresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateresourcecountresponse
      x-cloudstack-command: updateResourceCount
      x-cloudstack-async: false
  /updateResourceLimit:
    get:
      operationId: updateResourceLimit
      summary: Updates resource limits for an account or domain.
      tags:
      - ResourceLimit
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateResourceLimit
          default: updateResourceLimit
      - $ref: '#/components/parameters/response'
      - name: resourcetype
        in: query
        description: Type of resource to update. Values are 0, 1, 2, 3, 4, 6, 7, 8, 9, 10 and 11. 0 - Instance. Number of Instances a user can create. 1 - IP. Number of public IP addresses a user can own. 2 - Volume. Number of disk volumes a user can create. 3 - Snapshot. Number of Snapshots a user can create. 4 - Template. Number of Templates that a user can register/create. 5 - Project. Number of Projects a user can create. 6 - Network. Number of guest Network a user can create. 7 - VPC. Number of VPC a user can create. 8 - CPU. Total number of CPU cores a user can use. 9 - Memory. Total Memory (in MB) a user can use. 10 - PrimaryStorage. Total primary storage space (in GiB) a user can use. 11 - SecondaryStorage. Total secondary storage space (in GiB) a user can use.
        required: true
        schema:
          type: integer
          format: int32
      - name: account
        in: query
        description: Update resource for a specified account. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: Update resource limits for all accounts in specified domain. If used with the account parameter, updates resource limits for a specified account in specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: max
        in: query
        description: Maximum resource limit.
        schema:
          type: integer
          format: int64
      - name: projectid
        in: query
        description: Update resource limits for project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      - name: tag
        in: query
        description: Tag for the resource type
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      responses:
        '200':
          description: Successful invocation of `updateResourceLimit`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateresourcelimitresponse:
                    oneOf:
                    - &id431
                      $ref: '#/components/schemas/ResourceLimit'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id431
                        - type: array
                          items: *id431
                required:
                - updateresourcelimitresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateresourcelimitresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateresourcelimitresponse
      x-cloudstack-command: updateResourceLimit
      x-cloudstack-async: false
      x-cloudstack-related:
      - listResourceLimits
  /updateResourceSchedule:
    get:
      operationId: updateResourceSchedule
      summary: Update Resource Schedule
      tags:
      - ResourceSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateResourceSchedule
          default: updateResourceSchedule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the schedule to be updated
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateResourceSchedule
      - name: description
        in: query
        description: Description of the schedule
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: Map of (key/value pairs) details for the schedule. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: enabled
        in: query
        description: Enable or disable the schedule.
        schema:
          type: boolean
      - name: enddate
        in: query
        description: End date after which the schedule becomes inactive. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: schedule
        in: query
        description: Schedule for action on resource in cron format.
        schema:
          type: string
          maxLength: 255
      - name: startdate
        in: query
        description: Start date from which the schedule becomes active. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: timezone
        in: query
        description: Specifies a timezone for this command.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateResourceSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateresourcescheduleresponse:
                    oneOf:
                    - &id432
                      $ref: '#/components/schemas/ResourceSchedule'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id432
                        - type: array
                          items: *id432
                required:
                - updateresourcescheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateresourcescheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateresourcescheduleresponse
      x-cloudstack-command: updateResourceSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.23.0
  /updateRole:
    get:
      operationId: updateRole
      summary: Updates a role
      tags:
      - Role
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateRole
          default: updateRole
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of the role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listRoles
        - updateRole
      - name: description
        in: query
        description: The description of the role
        schema:
          type: string
          maxLength: 255
      - name: ispublic
        in: query
        description: Indicates whether the role will be visible to all users (public) or only to root admins (private).
        schema:
          type: boolean
      - name: name
        in: query
        description: Creates a role with this unique name
        schema:
          type: string
          maxLength: 255
      - name: type
        in: query
        description: 'The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateRole`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateroleresponse:
                    oneOf:
                    - &id433
                      $ref: '#/components/schemas/Role'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id433
                        - type: array
                          items: *id433
                required:
                - updateroleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateroleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateroleresponse
      x-cloudstack-command: updateRole
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
      x-cloudstack-related:
      - listRoles
  /updateRolePermission:
    get:
      operationId: updateRolePermission
      summary: Updates a role permission order
      tags:
      - RolePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateRolePermission
          default: updateRolePermission
      - $ref: '#/components/parameters/response'
      - name: roleid
        in: query
        description: ID of the role
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createRole
        - listRoles
        - updateRole
      - name: permission
        in: query
        description: 'Rule permission, can be: allow or deny'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.11'
      - name: ruleid
        in: query
        description: Role permission rule id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.11'
      - name: ruleorder
        in: query
        description: The parent role permission UUID, use 0 to move this rule at the top of the list. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `updateRolePermission`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updaterolepermissionresponse:
                    oneOf:
                    - &id434
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id434
                        - type: array
                          items: *id434
                required:
                - updaterolepermissionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updaterolepermissionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updaterolepermissionresponse
      x-cloudstack-command: updateRolePermission
      x-cloudstack-async: false
      x-cloudstack-since: 4.9.0
  /updateRoutingFirewallRule:
    get:
      operationId: updateRoutingFirewallRule
      summary: Updates Routing firewall rule with specified ID
      description: |-
        Updates Routing firewall rule with specified ID

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - RoutingFirewallRule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateRoutingFirewallRule
          default: updateRoutingFirewallRule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the Routing firewall rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createIpv6FirewallRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listIpForwardingRules
        - listIpv6FirewallRules
        - listPortForwardingRules
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
        - updateRoutingFirewallRule
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: an optional field, whether to the display the Routing firewall rule to the end user or not
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `updateRoutingFirewallRule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateroutingfirewallruleresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updateroutingfirewallruleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateroutingfirewallruleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateroutingfirewallruleresponse
      x-cloudstack-command: updateRoutingFirewallRule
      x-cloudstack-async: true
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createIpForwardingRule
      - createIpv6FirewallRule
      - createPortForwardingRule
      - createRoutingFirewallRule
      - listIpForwardingRules
      - listIpv6FirewallRules
      - listPortForwardingRules
      - listRoutingFirewallRules
      - updateIpv6FirewallRule
      - updatePortForwardingRule
      x-cloudstack-jobresult-schema: '#/components/schemas/Ipv6FirewallRule'
  /updateSecondaryStorageSelector:
    get:
      operationId: updateSecondaryStorageSelector
      summary: Updates an existing secondary storage selector.
      tags:
      - SecondaryStorageSelector
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateSecondaryStorageSelector
          default: updateSecondaryStorageSelector
      - $ref: '#/components/parameters/response'
      - name: heuristicrule
        in: query
        description: The heuristic rule, in JavaScript language. It is required that it returns the UUID of a secondary storage pool. An example of a rule is `if (snapshot.hypervisorType === 'KVM') { '7832f261-c602-4e8e-8580-2496ffbbc45d'; }` would allocate all snapshots with the KVM hypervisor to the specified secondary storage UUID.
        required: true
        schema:
          type: string
          maxLength: 65535
      - name: id
        in: query
        description: The unique identifier of the secondary storage selector.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listSecondaryStorageSelectors
        - updateSecondaryStorageSelector
      responses:
        '200':
          description: Successful invocation of `updateSecondaryStorageSelector`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesecondarystorageselectorresponse:
                    oneOf:
                    - &id435
                      $ref: '#/components/schemas/SecondaryStorageSelector'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id435
                        - type: array
                          items: *id435
                required:
                - updatesecondarystorageselectorresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesecondarystorageselectorresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatesecondarystorageselectorresponse
      x-cloudstack-command: updateSecondaryStorageSelector
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - listSecondaryStorageSelectors
  /updateSecurityGroup:
    get:
      operationId: updateSecurityGroup
      summary: Updates a security group
      tags:
      - SecurityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateSecurityGroup
          default: updateSecurityGroup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the security group.
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateSecurityGroup
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: name
        in: query
        description: The new name of the security group.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateSecurityGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesecuritygroupresponse:
                    oneOf:
                    - &id436
                      $ref: '#/components/schemas/SecurityGroup'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id436
                        - type: array
                          items: *id436
                required:
                - updatesecuritygroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesecuritygroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatesecuritygroupresponse
      x-cloudstack-command: updateSecurityGroup
      x-cloudstack-async: false
      x-cloudstack-since: 4.14.0.0
  /updateServiceOffering:
    get:
      operationId: updateServiceOffering
      summary: Updates a service offering.
      tags:
      - ServiceOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateServiceOffering
          default: updateServiceOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the service offering to be updated
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateServiceOffering
      - name: cleanupexternaldetails
        in: query
        description: Optional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this offering, externaldetails field ignored; if false or not set, no action)
        schema:
          type: boolean
        x-cloudstack-since: 4.22.0
      - name: displaytext
        in: query
        description: The display text of the service offering to be updated
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s) as comma separated string, public for public offerings
        schema:
          type: string
          maxLength: 4096
      - name: externaldetails
        in: query
        description: 'Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue. Map parameter. CloudStack expects it index-encoded as `externaldetails[0].key=k&externaldetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.21.0
      - name: hosttags
        in: query
        description: The host tag for this service offering.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.16'
      - name: name
        in: query
        description: The name of the service offering to be updated
        schema:
          type: string
          maxLength: 255
      - name: purgeresources
        in: query
        description: Whether to cleanup VM and its associated resource upon expunge
        schema:
          type: boolean
        x-cloudstack-since: '4.20'
      - name: sortkey
        in: query
        description: Sort key of the service offering, integer
        schema:
          type: integer
          format: int32
      - name: state
        in: query
        description: state of the service offering
        schema:
          type: string
          maxLength: 255
      - name: storagetags
        in: query
        description: Comma-separated list of tags for the service offering, tags should match with existing storage pool tags
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.16'
      - name: zoneid
        in: query
        description: The ID of the containing zone(s) as comma separated string, all for all zones offerings
        schema:
          type: string
          maxLength: 4096
        x-cloudstack-since: '4.13'
      responses:
        '200':
          description: Successful invocation of `updateServiceOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateserviceofferingresponse:
                    oneOf:
                    - &id437
                      $ref: '#/components/schemas/ServiceOffering'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id437
                        - type: array
                          items: *id437
                required:
                - updateserviceofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateserviceofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateserviceofferingresponse
      x-cloudstack-command: updateServiceOffering
      x-cloudstack-async: false
  /updateSharedFileSystem:
    get:
      operationId: updateSharedFileSystem
      summary: Update a Shared FileSystem
      tags:
      - SharedFileSystem
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateSharedFileSystem
          default: updateSharedFileSystem
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the shared filesystem
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeSharedFileSystemDiskOffering
        - changeSharedFileSystemServiceOffering
        - createSharedFileSystem
        - listSharedFileSystems
        - startSharedFileSystem
        - stopSharedFileSystem
        - updateSharedFileSystem
      - name: description
        in: query
        description: the description for the shared filesystem.
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: the name of the shared filesystem.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateSharedFileSystem`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesharedfilesystemresponse:
                    oneOf:
                    - &id438
                      $ref: '#/components/schemas/SharedFileSystem'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id438
                        - type: array
                          items: *id438
                required:
                - updatesharedfilesystemresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesharedfilesystemresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatesharedfilesystemresponse
      x-cloudstack-command: updateSharedFileSystem
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - changeSharedFileSystemDiskOffering
      - changeSharedFileSystemServiceOffering
      - createSharedFileSystem
      - listSharedFileSystems
      - startSharedFileSystem
      - stopSharedFileSystem
  /updateSiocInfo:
    get:
      operationId: updateSiocInfo
      summary: Update SIOC info
      tags:
      - SiocInfo
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateSiocInfo
          default: updateSiocInfo
      - $ref: '#/components/parameters/response'
      - name: iopsnotifythreshold
        in: query
        description: Notify if IOPS above this value
        required: true
        schema:
          type: integer
          format: int32
      - name: limitiopspergb
        in: query
        description: Limit IOPS per GB
        required: true
        schema:
          type: integer
          format: int32
      - name: sharespergb
        in: query
        description: Shares per GB
        required: true
        schema:
          type: integer
          format: int32
      - name: storageid
        in: query
        description: Storage Pool ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
      - name: zoneid
        in: query
        description: Zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      responses:
        '200':
          description: Successful invocation of `updateSiocInfo`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesiocinforesponse:
                    oneOf:
                    - &id439
                      $ref: '#/components/schemas/SiocInfo'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id439
                        - type: array
                          items: *id439
                required:
                - updatesiocinforesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesiocinforesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatesiocinforesponse
      x-cloudstack-command: updateSiocInfo
      x-cloudstack-async: false
      x-cloudstack-since: 4.11.0
  /updateSnapshotPolicy:
    get:
      operationId: updateSnapshotPolicy
      summary: Updates the Snapshot policy.
      description: |-
        Updates the Snapshot policy.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - SnapshotPolicy
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateSnapshotPolicy
          default: updateSnapshotPolicy
      - $ref: '#/components/parameters/response'
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the Snapshot policy to the end user or not.
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: id
        in: query
        description: The ID of the Snapshot policy
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateSnapshotPolicy
      responses:
        '200':
          description: Successful invocation of `updateSnapshotPolicy`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesnapshotpolicyresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatesnapshotpolicyresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatesnapshotpolicyresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatesnapshotpolicyresponse
      x-cloudstack-command: updateSnapshotPolicy
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/SnapshotPolicy'
  /updateStorageCapabilities:
    get:
      operationId: updateStorageCapabilities
      summary: Syncs capabilities of storage pools
      tags:
      - StorageCapability
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateStorageCapabilities
          default: updateStorageCapabilities
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Storage pool id
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
      responses:
        '200':
          description: Successful invocation of `updateStorageCapabilities`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatestoragecapabilitiesresponse:
                    oneOf:
                    - &id440
                      $ref: '#/components/schemas/StoragePool'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id440
                        - type: array
                          items: *id440
                required:
                - updatestoragecapabilitiesresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatestoragecapabilitiesresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatestoragecapabilitiesresponse
      x-cloudstack-command: updateStorageCapabilities
      x-cloudstack-async: false
      x-cloudstack-since: 4.16.0
      x-cloudstack-related:
      - cancelStorageMaintenance
      - createStoragePool
      - enableStorageMaintenance
      - findStoragePoolsForMigration
      - syncStoragePool
  /updateStorageNetworkIpRange:
    get:
      operationId: updateStorageNetworkIpRange
      summary: Update a Storage network IP range, only allowed when no IPs in this range have been allocated.
      description: |-
        Update a Storage network IP range, only allowed when no IPs in this range have been allocated.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - StorageNetworkIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateStorageNetworkIpRange
          default: updateStorageNetworkIpRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: UUID of storage network ip range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createStorageNetworkIpRange
        - listStorageNetworkIpRange
        - updateStorageNetworkIpRange
      - name: endip
        in: query
        description: The ending IP address
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The netmask for storage network
        schema:
          type: string
          maxLength: 255
      - name: startip
        in: query
        description: The beginning IP address
        schema:
          type: string
          maxLength: 255
      - name: vlan
        in: query
        description: Optional. the vlan the ip range sits on
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `updateStorageNetworkIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatestoragenetworkiprangeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatestoragenetworkiprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatestoragenetworkiprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatestoragenetworkiprangeresponse
      x-cloudstack-command: updateStorageNetworkIpRange
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - createStorageNetworkIpRange
      - listStorageNetworkIpRange
      x-cloudstack-jobresult-schema: '#/components/schemas/StorageNetworkIpRange'
  /updateStoragePool:
    get:
      operationId: updateStoragePool
      summary: Updates a storage pool.
      tags:
      - StoragePool
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateStoragePool
          default: updateStoragePool
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The Id of the storage pool
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: capacitybytes
        in: query
        description: Bytes CloudStack can provision from this storage pool
        schema:
          type: integer
          format: int64
      - name: capacityiops
        in: query
        description: IOPS CloudStack can provision from this storage pool
        schema:
          type: integer
          format: int64
      - name: details
        in: query
        description: the details for the storage pool. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: 4.19.0
      - name: enabled
        in: query
        description: False to disable the pool for allocation of new volumes, true to enable it back.
        schema:
          type: boolean
      - name: istagarule
        in: query
        description: Whether the informed tag is a JS interpretable rule or not.
        schema:
          type: boolean
      - name: name
        in: query
        description: Change the name of the storage pool
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.15'
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
        - updateStorageCapabilities
        - updateStoragePool
      - name: tags
        in: query
        description: Comma-separated list of tags for the storage pool. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: url
        in: query
        description: the URL of the storage pool
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.19.0
      responses:
        '200':
          description: Successful invocation of `updateStoragePool`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatestoragepoolresponse:
                    oneOf:
                    - &id441
                      $ref: '#/components/schemas/StoragePool'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id441
                        - type: array
                          items: *id441
                required:
                - updatestoragepoolresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatestoragepoolresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatestoragepoolresponse
      x-cloudstack-command: updateStoragePool
      x-cloudstack-async: false
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - cancelStorageMaintenance
      - createStoragePool
      - enableStorageMaintenance
      - findStoragePoolsForMigration
      - syncStoragePool
      - updateStorageCapabilities
  /updateTemplate:
    get:
      operationId: updateTemplate
      summary: Updates attributes of a Template.
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateTemplate
          default: updateTemplate
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the image file
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateTemplate
        - updateVnfTemplate
      - name: arch
        in: query
        description: 'the CPU arch of the template/ISO. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: bootable
        in: query
        description: True if image is bootable, false otherwise; available only for updateIso API
        schema:
          type: boolean
      - name: cleanupdetails
        in: query
        description: Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)
        schema:
          type: boolean
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: displaytext
        in: query
        description: The display text of the image
        schema:
          type: string
          maxLength: 4096
      - name: forceupdateostype
        in: query
        description: 'Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.'
        schema:
          type: boolean
        x-cloudstack-since: '4.21'
      - name: forcks
        in: query
        description: indicates that the template can be used for deployment of CKS clusters
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: format
        in: query
        description: The format for the image
        schema:
          type: string
          maxLength: 255
      - name: isdynamicallyscalable
        in: query
        description: True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
        schema:
          type: boolean
      - name: isrouting
        in: query
        description: True if the Template type is routing i.e., if Template is used to deploy router
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the image file
        schema:
          type: string
          maxLength: 251
      - name: ostypeid
        in: query
        description: The ID of the OS type that best represents the OS of this image.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
      - name: passwordenabled
        in: query
        description: True if the image supports the password reset feature; default is false
        schema:
          type: boolean
      - name: requireshvm
        in: query
        description: True if the Template requires HVM, false otherwise; available only for updateTemplate API
        schema:
          type: boolean
      - name: sortkey
        in: query
        description: Sort key of the Template, integer
        schema:
          type: integer
          format: int32
      - name: sshkeyenabled
        in: query
        description: True if the Template supports the SSHkey upload feature; default is false
        schema:
          type: boolean
      - name: templatetag
        in: query
        description: the tag for this template.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: templatetype
        in: query
        description: 'The type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).'
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatetemplateresponse:
                    oneOf:
                    - &id442
                      $ref: '#/components/schemas/Template'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id442
                        - type: array
                          items: *id442
                required:
                - updatetemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatetemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatetemplateresponse
      x-cloudstack-command: updateTemplate
      x-cloudstack-async: false
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - linkUserDataToTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateVnfTemplate
  /updateTemplatePermissions:
    get:
      operationId: updateTemplatePermissions
      summary: Updates a Template visibility permissions.
      description: Updates a Template visibility permissions. A public Template is visible to all accounts within the same domain. A private Template is visible only to the owner of the Template. A privileged Template is a private Template with account permissions added. Only accounts specified under the Template permissions are visible to them.
      tags:
      - TemplatePermission
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateTemplatePermissions
          default: updateTemplatePermissions
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The Template ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - linkUserDataToTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - prepareTemplate
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateIso
        - updateTemplate
        - updateVnfTemplate
      - name: accounts
        in: query
        description: A comma delimited list of Accounts within caller's domain. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: isextractable
        in: query
        description: True if the Template/ISO is extractable, false otherwise. Can be set only by root admin
        schema:
          type: boolean
      - name: isfeatured
        in: query
        description: True for featured Template/ISO, false otherwise
        schema:
          type: boolean
      - name: ispublic
        in: query
        description: True for public Template/ISO, false for private Templates/ISOs
        schema:
          type: boolean
      - name: op
        in: query
        description: Permission operator (add, remove, reset)
        schema:
          type: string
          maxLength: 255
      - name: projectids
        in: query
        description: A comma delimited list of projects. If specified, "op" parameter has to be passed in. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
        x-cloudstack-related:
        - activateProject
        - createProject
        - listProjectAccounts
        - listProjects
        - suspendProject
        - updateProject
      responses:
        '200':
          description: Successful invocation of `updateTemplatePermissions`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatetemplatepermissionsresponse:
                    oneOf:
                    - &id443
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id443
                        - type: array
                          items: *id443
                required:
                - updatetemplatepermissionsresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatetemplatepermissionsresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatetemplatepermissionsresponse
      x-cloudstack-command: updateTemplatePermissions
      x-cloudstack-async: false
  /updateTrafficType:
    get:
      operationId: updateTrafficType
      summary: Updates traffic type of a physical network
      description: |-
        Updates traffic type of a physical network

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TrafficType
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateTrafficType
          default: updateTrafficType
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: Traffic type ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addTrafficType
        - listTrafficTypes
        - updateTrafficType
      - name: hypervnetworklabel
        in: query
        description: The network name label of the physical device dedicated to this traffic on a Hyperv host
        schema:
          type: string
          maxLength: 255
      - name: kvmnetworklabel
        in: query
        description: The network name label of the physical device dedicated to this traffic on a KVM host
        schema:
          type: string
          maxLength: 255
      - name: ovm3networklabel
        in: query
        description: The network name of the physical device dedicated to this traffic on an OVM3 host
        schema:
          type: string
          maxLength: 255
      - name: vmwarenetworklabel
        in: query
        description: The network name label of the physical device dedicated to this traffic on a VMware host
        schema:
          type: string
          maxLength: 255
      - name: xennetworklabel
        in: query
        description: The network name label of the physical device dedicated to this traffic on a XenServer host
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateTrafficType`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatetraffictyperesponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatetraffictyperesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatetraffictyperesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatetraffictyperesponse
      x-cloudstack-command: updateTrafficType
      x-cloudstack-async: true
      x-cloudstack-since: 3.0.0
      x-cloudstack-related:
      - addTrafficType
      - listTrafficTypes
      x-cloudstack-jobresult-schema: '#/components/schemas/TrafficType'
  /updateTungstenFabricLBHealthMonitor:
    get:
      operationId: updateTungstenFabricLBHealthMonitor
      summary: Update Tungsten-Fabric loadbalancer health monitor
      description: |-
        Update Tungsten-Fabric loadbalancer health monitor

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - TungstenFabricLBHealthMonitor
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateTungstenFabricLBHealthMonitor
          default: updateTungstenFabricLBHealthMonitor
      - $ref: '#/components/parameters/response'
      - name: interval
        in: query
        description: Loadbalancer health monitor interval
        required: true
        schema:
          type: integer
          format: int32
      - name: lbruleid
        in: query
        description: The ID of LB rule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createIpForwardingRule
        - createPortForwardingRule
        - createRoutingFirewallRule
        - listRoutingFirewallRules
        - updateIpv6FirewallRule
        - updatePortForwardingRule
      - name: retry
        in: query
        description: Loadbalancer health monitor retry
        required: true
        schema:
          type: integer
          format: int32
      - name: timeout
        in: query
        description: Loadbalancer health monitor timeout
        required: true
        schema:
          type: integer
          format: int32
      - name: type
        in: query
        description: Loadbalancer health monitor type
        required: true
        schema:
          type: string
          maxLength: 255
      - name: expectedcode
        in: query
        description: Loadbalancer health monitor expected code
        schema:
          type: string
          maxLength: 255
      - name: httpmethodtype
        in: query
        description: Loadbalancer health monitor HTTP method
        schema:
          type: string
          maxLength: 255
      - name: urlpath
        in: query
        description: Loadbalancer health monitor URL path
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateTungstenFabricLBHealthMonitor`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatetungstenfabriclbhealthmonitorresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatetungstenfabriclbhealthmonitorresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatetungstenfabriclbhealthmonitorresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatetungstenfabriclbhealthmonitorresponse
      x-cloudstack-command: updateTungstenFabricLBHealthMonitor
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/TungstenFabricLBHealthMonitor'
  /updateUser:
    get:
      operationId: updateUser
      summary: Updates a user account
      tags:
      - User
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateUser
          default: updateUser
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: User uuid
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createUser
        - disableUser
        - enableUser
        - getUser
        - listUsers
        - lockUser
        - updateUser
      - name: apikeyaccess
        in: query
        description: Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.1.0
      - name: currentpassword
        in: query
        description: Current password that was being used by the user. You must inform the current password when updating the password.
        schema:
          type: string
          maxLength: 255
      - name: email
        in: query
        description: Email
        schema:
          type: string
          maxLength: 255
      - name: firstname
        in: query
        description: First name
        schema:
          type: string
          maxLength: 255
      - name: lastname
        in: query
        description: Last name
        schema:
          type: string
          maxLength: 255
      - name: mandate2fa
        in: query
        description: Provide true to mandate the user to use two factor authentication has to be enabled.This parameter is only used to mandate 2FA, not to disable 2FA
        schema:
          type: boolean
        x-cloudstack-since: 4.18.0.0
      - name: password
        in: query
        description: Clear text password (default hashed to SHA256SALT). If you wish to use any other hashing algorithm, you would need to write a custom authentication adapter. Can't be passed when command is executed via integration.api.port
        schema:
          type: string
          maxLength: 255
      - name: passwordchangerequired
        in: query
        description: Provide true to mandate the User to reset password on next login.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.
        schema:
          type: string
          maxLength: 255
      - name: userapikey
        in: query
        description: Updates the latest API key of the user. Must be specified with usersecretkey
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: Unique username
        schema:
          type: string
          maxLength: 255
      - name: usersecretkey
        in: query
        description: Updates the latest secret key of the user. Must be specified with userapikey.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateuserresponse:
                    oneOf:
                    - &id444
                      $ref: '#/components/schemas/User2'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id444
                        - type: array
                          items: *id444
                required:
                - updateuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updateuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updateuserresponse
      x-cloudstack-command: updateUser
      x-cloudstack-async: false
      x-cloudstack-related:
      - createUser
      - disableUser
      - enableUser
      - getUser
      - listUsers
      - lockUser
  /updateVMAffinityGroup:
    get:
      operationId: updateVMAffinityGroup
      summary: Updates the affinity/anti-affinity group associations of an Instance.
      description: |-
        Updates the affinity/anti-affinity group associations of an Instance. The Instance has to be stopped and restarted for the new properties to take effect.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - AffinityGroup
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVMAffinityGroup
          default: updateVMAffinityGroup
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: affinitygroupids
        in: query
        description: Comma separated list of affinity groups id that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupnames parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: affinitygroupnames
        in: query
        description: Comma separated list of affinity groups names that are going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      responses:
        '200':
          description: Successful invocation of `updateVMAffinityGroup`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmaffinitygroupresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevmaffinitygroupresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmaffinitygroupresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevmaffinitygroupresponse
      x-cloudstack-command: updateVMAffinityGroup
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /updateVMSchedule:
    get:
      operationId: updateVMSchedule
      summary: Update Instance Schedule.
      tags:
      - VMSchedule
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVMSchedule
          default: updateVMSchedule
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of Instance schedule
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVMSchedule
      - name: description
        in: query
        description: Name of the schedule
        schema:
          type: string
          maxLength: 255
      - name: enabled
        in: query
        description: Enable Instance schedule
        schema:
          type: boolean
      - name: enddate
        in: query
        description: End date after which the schedule becomes inactive(Format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: schedule
        in: query
        description: Schedule for action on Instance in cron format. e.g. '0 15 10 * *' for 'at 15:00 on 10th day of every month'
        schema:
          type: string
          maxLength: 255
      - name: startdate
        in: query
        description: Start date from which the schedule becomes active(Format "yyyy-MM-dd hh:mm:ss"). CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        schema:
          type: string
          x-cloudstack-type: date
          maxLength: 255
      - name: timezone
        in: query
        description: Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateVMSchedule`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmscheduleresponse:
                    oneOf:
                    - &id445
                      $ref: '#/components/schemas/VMSchedule'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id445
                        - type: array
                          items: *id445
                required:
                - updatevmscheduleresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmscheduleresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevmscheduleresponse
      x-cloudstack-command: updateVMSchedule
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
  /updateVPC:
    get:
      operationId: updateVPC
      summary: Updates a VPC
      description: |-
        Updates a VPC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPC
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVPC
          default: updateVPC
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the VPC
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVPC
        - listVPCs
        - migrateVPC
        - updateVPC
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: displaytext
        in: query
        description: The display text of the VPC
        schema:
          type: string
          maxLength: 255
      - name: fordisplay
        in: query
        description: Optional field, should we display the VPC to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      - name: keepmacaddressonpublicnic
        in: query
        description: Indicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have  a new MAC address.
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: name
        in: query
        description: The name of the VPC
        schema:
          type: string
          maxLength: 255
      - name: publicmtu
        in: query
        description: MTU to be configured on the Network VR's public facing interfaces
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.18.0
      - name: sourcenatipaddress
        in: query
        description: IPV4 address to be assigned to the public interface of the Network router. This address must already be acquired for this VPC
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.19'
      responses:
        '200':
          description: Successful invocation of `updateVPC`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpcresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevpcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevpcresponse
      x-cloudstack-command: updateVPC
      x-cloudstack-async: true
      x-cloudstack-related:
      - createVPC
      - listVPCs
      - migrateVPC
      - updateVPC
      x-cloudstack-jobresult-schema: '#/components/schemas/VPC'
  /updateVPCOffering:
    get:
      operationId: updateVPCOffering
      summary: Updates VPC offering
      description: |-
        Updates VPC offering

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VPCOffering
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVPCOffering
          default: updateVPCOffering
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the VPC offering
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVPCOffering
      - name: displaytext
        in: query
        description: The display text of the VPC offering
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The ID of the containing domain(s) as comma separated string, public for public offerings
        schema:
          type: string
          maxLength: 4096
      - name: name
        in: query
        description: The name of the VPC offering
        schema:
          type: string
          maxLength: 255
      - name: sortkey
        in: query
        description: Sort key of the VPC offering, integer
        schema:
          type: integer
          format: int32
      - name: state
        in: query
        description: Update state for the VPC offering; supported states - Enabled/Disabled
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: The ID of the containing zone(s) as comma separated string, all for all zones offerings
        schema:
          type: string
          maxLength: 4096
        x-cloudstack-since: '4.13'
      responses:
        '200':
          description: Successful invocation of `updateVPCOffering`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpcofferingresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevpcofferingresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpcofferingresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevpcofferingresponse
      x-cloudstack-command: updateVPCOffering
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/VPCOffering'
  /updateVgpuProfile:
    get:
      operationId: updateVgpuProfile
      summary: Updates a vGPU profile in the system
      tags:
      - VgpuProfile
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVgpuProfile
          default: updateVgpuProfile
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: the ID of the vGPU profile
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createVgpuProfile
        - updateVgpuProfile
      - name: description
        in: query
        description: the description of the vGPU profile
        schema:
          type: string
          maxLength: 255
      - name: maxheads
        in: query
        description: the maximum number of display heads
        schema:
          type: integer
          format: int64
      - name: maxresolutionx
        in: query
        description: the maximum X resolution
        schema:
          type: integer
          format: int64
      - name: maxresolutiony
        in: query
        description: the maximum Y resolution
        schema:
          type: integer
          format: int64
      - name: maxvgpuperphysicalgpu
        in: query
        description: the maximum number of vGPUs per physical GPU
        schema:
          type: integer
          format: int64
      - name: name
        in: query
        description: the name of the vGPU profile
        schema:
          type: string
          maxLength: 255
      - name: videoram
        in: query
        description: the video RAM size in MB
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful invocation of `updateVgpuProfile`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevgpuprofileresponse:
                    oneOf:
                    - &id446
                      $ref: '#/components/schemas/VgpuProfile'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id446
                        - type: array
                          items: *id446
                required:
                - updatevgpuprofileresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevgpuprofileresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevgpuprofileresponse
      x-cloudstack-command: updateVgpuProfile
      x-cloudstack-async: false
      x-cloudstack-since: 4.21.0
      x-cloudstack-related:
      - createVgpuProfile
  /updateVirtualMachine:
    get:
      operationId: updateVirtualMachine
      summary: Updates properties of  an Instance.
      description: Updates properties of  an Instance. The Instance has to be stopped and restarted for the new properties to take effect. UpdateVirtualMachine does not first check whether the Instance is stopped. Therefore, stop the Instance manually before issuing this call.
      tags:
      - VirtualMachine
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVirtualMachine
          default: updateVirtualMachine
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Instance
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addNicToVirtualMachine
        - attachIso
        - changeServiceForVirtualMachine
        - createVMFromBackup
        - deployVirtualMachine
        - deployVnfAppliance
        - destroyVirtualMachine
        - detachIso
        - importVm
        - listVirtualMachines
        - listVnfAppliances
        - rebootVirtualMachine
        - removeNicFromVirtualMachine
        - resetPasswordForVirtualMachine
        - resetSSHKeyForVirtualMachine
        - resetUserDataForVirtualMachine
        - restoreVirtualMachine
        - revertToVMSnapshot
        - scaleVirtualMachine
        - startVirtualMachine
        - stopVirtualMachine
        - updateDefaultNicForVirtualMachine
        - updateVMAffinityGroup
        - updateVirtualMachine
      - name: cleanupdetails
        in: query
        description: Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)
        schema:
          type: boolean
      - name: cleanupextraconfig
        in: query
        description: Optional boolean field, which indicates if extraconfig for the instance should be cleaned up or not (If set to true, extraconfig removed for this instance, extraconfig field ignored; if false or not set, no action)
        schema:
          type: boolean
        x-cloudstack-since: 4.23.0
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: deleteprotection
        in: query
        description: 'Set delete protection for the virtual machine. If true, the instance will be protected from deletion. Note: If the instance is managed by another service like autoscaling groups or CKS, delete protection will be ignored.'
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: details
        in: query
        description: Details in key/value pairs. 'extraconfig' is not allowed to be passed in details. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: dhcpoptionsnetworklist
        in: query
        description: 'DHCP options which are passed to the Instance on start up Example: dhcpoptionsnetworklist[0].dhcp:114=url&dhcpoptionsetworklist[0].networkid=networkid&dhcpoptionsetworklist[0].dhcp:66=www.test.com. Map parameter. CloudStack expects it index-encoded as `dhcpoptionsnetworklist[0].key=k&dhcpoptionsnetworklist[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: displayname
        in: query
        description: User generated name
        schema:
          type: string
          maxLength: 255
      - name: displayvm
        in: query
        description: An optional field, whether to the display the Instance to the end User or not.
        schema:
          type: boolean
      - name: extraconfig
        in: query
        description: An optional URL encoded string that can be passed to the Instance upon successful deployment
        schema:
          type: string
          maxLength: 5120
        x-cloudstack-since: '4.12'
      - name: group
        in: query
        description: Group of the Instance
        schema:
          type: string
          maxLength: 255
      - name: haenable
        in: query
        description: True if high-availability is enabled for the Instance, false otherwise
        schema:
          type: boolean
      - name: instancename
        in: query
        description: Instance name of the User Instance
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: isdynamicallyscalable
        in: query
        description: True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance cpu/memory. This can be updated only when dynamic scaling is enabled on Template, service offering and the corresponding global setting
        schema:
          type: boolean
      - name: leaseduration
        in: query
        description: Number of days to lease the instance from now onward. Use -1 to remove the existing lease
        schema:
          type: integer
          format: int32
        x-cloudstack-since: 4.21.0
      - name: leaseexpiryaction
        in: query
        description: Lease expiry action, valid values are STOP and DESTROY
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.21.0
      - name: name
        in: query
        description: New host name of the Instance. The Instance has to be stopped/started for this update to take affect
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: ostypeid
        in: query
        description: The ID of the OS type that best represents this Instance.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addGuestOs
      - name: securitygroupids
        in: query
        description: List of security group ids to be applied on the Instance. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: securitygroupnames
        in: query
        description: Comma separated list of security groups names that going to be applied to the Instance. Should be passed only when Instance is created from a zone with Basic Network support. Mutually exclusive with securitygroupids parameter. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: userdata
        in: query
        description: An optional binary data that can be sent to the Instance upon a successful deployment. This binary data must be base64 encoded before adding it to the request. Using HTTP GET (via querystring), you can send up to 4KB of data after base64 encoding. Using HTTP POST (via POST body), you can send up to 1MB of data after base64 encoding. You also need to change vm.userdata.max.length value
        schema:
          type: string
          maxLength: 1048576
        x-cloudstack-since: 4.16.0
      - name: userdatadetails
        in: query
        description: Used to specify the parameters values for the variables in userdata. Map parameter. CloudStack expects it index-encoded as `userdatadetails[0].key=k&userdatadetails[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
        x-cloudstack-since: '4.18'
      - name: userdataid
        in: query
        description: The ID of the userdata
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.18'
      responses:
        '200':
          description: Successful invocation of `updateVirtualMachine`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevirtualmachineresponse:
                    oneOf:
                    - &id447
                      $ref: '#/components/schemas/VirtualMachine'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id447
                        - type: array
                          items: *id447
                required:
                - updatevirtualmachineresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevirtualmachineresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevirtualmachineresponse
      x-cloudstack-command: updateVirtualMachine
      x-cloudstack-async: false
      x-cloudstack-related:
      - addNicToVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - rebootVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
  /updateVlanIpRange:
    get:
      operationId: updateVlanIpRange
      summary: Updates a VLAN IP range.
      tags:
      - VlanIpRange
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVlanIpRange
          default: updateVlanIpRange
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The UUID of the VLAN IP range
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVlanIpRange
      - name: endip
        in: query
        description: The ending IP address in the VLAN IP range
        schema:
          type: string
          maxLength: 255
      - name: endipv6
        in: query
        description: The ending IPv6 address in the IPv6 Network range
        schema:
          type: string
          maxLength: 255
      - name: forsystemvms
        in: query
        description: True if IP range is set to System VM, false if not
        schema:
          type: boolean
      - name: gateway
        in: query
        description: The gateway of the VLAN IP range
        schema:
          type: string
          maxLength: 255
      - name: ip6cidr
        in: query
        description: The CIDR of IPv6 Network, must be at least /64
        schema:
          type: string
          maxLength: 255
      - name: ip6gateway
        in: query
        description: The gateway of the IPv6 Network
        schema:
          type: string
          maxLength: 255
      - name: netmask
        in: query
        description: The netmask of the VLAN IP range
        schema:
          type: string
          maxLength: 255
      - name: startip
        in: query
        description: The beginning IP address in the VLAN IP range
        schema:
          type: string
          maxLength: 255
      - name: startipv6
        in: query
        description: The beginning IPv6 address in the IPv6 Network range
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateVlanIpRange`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevlaniprangeresponse:
                    oneOf:
                    - &id448
                      $ref: '#/components/schemas/VlanIpRange'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id448
                        - type: array
                          items: *id448
                required:
                - updatevlaniprangeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevlaniprangeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevlaniprangeresponse
      x-cloudstack-command: updateVlanIpRange
      x-cloudstack-async: false
      x-cloudstack-since: 4.16.0
  /updateVmNic:
    get:
      operationId: updateVmNic
      summary: Updates the specified VM NIC
      description: |-
        Updates the specified VM NIC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VmNic
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVmNic
          default: updateVmNic
      - $ref: '#/components/parameters/response'
      - name: nicid
        in: query
        description: NIC ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVmNic
      - name: enabled
        in: query
        description: If true, sets the NIC state to UP; otherwise, sets the NIC state to DOWN
        schema:
          type: boolean
      responses:
        '200':
          description: Successful invocation of `updateVmNic`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmnicresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevmnicresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmnicresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevmnicresponse
      x-cloudstack-command: updateVmNic
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/ListNicsResult'
  /updateVmNicIp:
    get:
      operationId: updateVmNicIp
      summary: Update the default IP of an Instance NIC
      description: |-
        Update the default IP of an Instance NIC

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VmNicIp
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVmNicIp
          default: updateVmNicIp
      - $ref: '#/components/parameters/response'
      - name: nicid
        in: query
        description: The ID of the NIC to which you want to assign private IP
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listNics
        - updateVmNic
      - name: ipaddress
        in: query
        description: Secondary IP Address
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateVmNicIp`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmnicipresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevmnicipresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmnicipresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevmnicipresponse
      x-cloudstack-command: updateVmNicIp
      x-cloudstack-async: true
      x-cloudstack-related:
      - addNicToVirtualMachine
      - assignVirtualMachine
      - attachIso
      - changeServiceForVirtualMachine
      - createVMFromBackup
      - deployVirtualMachine
      - deployVnfAppliance
      - destroyVirtualMachine
      - detachIso
      - importUnmanagedInstance
      - importVm
      - listVirtualMachines
      - listVnfAppliances
      - migrateVirtualMachine
      - migrateVirtualMachineWithVolume
      - rebootVirtualMachine
      - recoverVirtualMachine
      - removeNicFromVirtualMachine
      - resetPasswordForVirtualMachine
      - resetSSHKeyForVirtualMachine
      - resetUserDataForVirtualMachine
      - restoreVirtualMachine
      - revertToVMSnapshot
      - scaleVirtualMachine
      - startVirtualMachine
      - stopVirtualMachine
      - updateDefaultNicForVirtualMachine
      - updateVMAffinityGroup
      - updateVirtualMachine
      x-cloudstack-jobresult-schema: '#/components/schemas/VirtualMachine'
  /updateVmwareDc:
    get:
      operationId: updateVmwareDc
      summary: Updates a VMware datacenter details for a zone
      tags:
      - VmwareDc
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVmwareDc
          default: updateVmwareDc
      - $ref: '#/components/parameters/response'
      - name: zoneid
        in: query
        description: The zone ID
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: isrecursive
        in: query
        description: Specify if cluster level username/password/url and host level guid need to be updated as well. By default this is true.
        schema:
          type: boolean
      - name: name
        in: query
        description: VMware datacenter name.
        schema:
          type: string
          maxLength: 255
      - name: password
        in: query
        description: The password for specified username.
        schema:
          type: string
          maxLength: 255
      - name: username
        in: query
        description: The username required to connect to resource.
        schema:
          type: string
          maxLength: 255
      - name: vcenter
        in: query
        description: The name/IP of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateVmwareDc`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmwaredcresponse:
                    oneOf:
                    - &id449
                      $ref: '#/components/schemas/VmwareDc'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id449
                        - type: array
                          items: *id449
                required:
                - updatevmwaredcresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevmwaredcresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevmwaredcresponse
      x-cloudstack-command: updateVmwareDc
      x-cloudstack-async: false
      x-cloudstack-since: 4.12.0
      x-cloudstack-related:
      - addVmwareDc
      - listVmwareDcs
  /updateVnfTemplate:
    get:
      operationId: updateVnfTemplate
      summary: Updates a template to VNF template or attributes of a VNF template.
      tags:
      - VnfTemplate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVnfTemplate
          default: updateVnfTemplate
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the image file
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - copyIso
        - copyTemplate
        - createTemplate
        - listIsos
        - listTemplates
        - listVnfTemplates
        - registerIso
        - registerTemplate
        - registerVnfTemplate
        - updateVnfTemplate
      - name: arch
        in: query
        description: 'the CPU arch of the template/ISO. Valid options are: x86_64, aarch64, s390x'
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.20'
      - name: bootable
        in: query
        description: True if image is bootable, false otherwise; available only for updateIso API
        schema:
          type: boolean
      - name: cleanupdetails
        in: query
        description: Optional boolean field, which indicates if details should be cleaned up or not (if set to true, details removed for this resource, details field ignored; if false or not set, no action)
        schema:
          type: boolean
      - name: cleanupvnfdetails
        in: query
        description: optional boolean field, which indicates if VNF details will be cleaned up or not
        schema:
          type: boolean
      - name: cleanupvnfnics
        in: query
        description: optional boolean field, which indicates if VNF nics will be cleaned up or not
        schema:
          type: boolean
      - name: details
        in: query
        description: 'Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: displaytext
        in: query
        description: The display text of the image
        schema:
          type: string
          maxLength: 4096
      - name: forceupdateostype
        in: query
        description: 'Force OS type update. Warning: Updating OS type will update the guest OS configuration for all the existing Instances deployed with this template/iso, which may affect their behavior.'
        schema:
          type: boolean
        x-cloudstack-since: '4.21'
      - name: forcks
        in: query
        description: indicates that the template can be used for deployment of CKS clusters
        schema:
          type: boolean
        x-cloudstack-since: 4.21.0
      - name: format
        in: query
        description: The format for the image
        schema:
          type: string
          maxLength: 255
      - name: isdynamicallyscalable
        in: query
        description: True if Template/ISO contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
        schema:
          type: boolean
      - name: isrouting
        in: query
        description: True if the Template type is routing i.e., if Template is used to deploy router
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the image file
        schema:
          type: string
          maxLength: 251
      - name: ostypeid
        in: query
        description: The ID of the OS type that best represents the OS of this image.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: passwordenabled
        in: query
        description: True if the image supports the password reset feature; default is false
        schema:
          type: boolean
      - name: requireshvm
        in: query
        description: True if the Template requires HVM, false otherwise; available only for updateTemplate API
        schema:
          type: boolean
      - name: sortkey
        in: query
        description: Sort key of the Template, integer
        schema:
          type: integer
          format: int32
      - name: sshkeyenabled
        in: query
        description: True if the Template supports the SSHkey upload feature; default is false
        schema:
          type: boolean
      - name: templatetag
        in: query
        description: the tag for this template.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.20.0
      - name: templatetype
        in: query
        description: 'The type of the Template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).'
        schema:
          type: string
          maxLength: 255
      - name: vnfdetails
        in: query
        description: 'VNF details in key/value pairs using format vnfdetails[i].keyname=keyvalue. Example: vnfdetails[0].vendor=xxx&&vnfdetails[0].version=2.0. Map parameter. CloudStack expects it index-encoded as `vnfdetails[0].key=k&vnfdetails[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: vnfnics
        in: query
        description: 'VNF nics in key/value pairs using format vnfnics[i].keyname=keyvalue.  Example: vnfnics[0].deviceid=0&&vnfnics[0].name=FirstNIC&&vnfnics[0].required=true&&vnfnics[1].deviceid=1&&vnfnics[1].name=SecondNIC. Map parameter. CloudStack expects it index-encoded as `vnfnics[0].key=k&vnfnics[0].value=v`.'
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      responses:
        '200':
          description: Successful invocation of `updateVnfTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevnftemplateresponse:
                    oneOf:
                    - &id450
                      $ref: '#/components/schemas/Template'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id450
                        - type: array
                          items: *id450
                required:
                - updatevnftemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevnftemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevnftemplateresponse
      x-cloudstack-command: updateVnfTemplate
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - copyIso
      - copyTemplate
      - createTemplate
      - listIsos
      - listTemplates
      - listVnfTemplates
      - registerIso
      - registerTemplate
      - registerVnfTemplate
      - updateVnfTemplate
  /updateVolume:
    get:
      operationId: updateVolume
      summary: Updates the volume.
      description: |-
        Updates the volume.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVolume
          default: updateVolume
      - $ref: '#/components/parameters/response'
      - name: chaininfo
        in: query
        description: The chain info of the volume
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: deleteprotection
        in: query
        description: 'Set delete protection for the volume. If true, The volume will be protected from deletion. Note: If the volume is managed by another service like autoscaling groups or CKS, delete protection will be ignored.'
        schema:
          type: boolean
        x-cloudstack-since: 4.20.0
      - name: displayvolume
        in: query
        description: An optional field, whether to the display the volume to the end User or not.
        schema:
          type: boolean
      - name: id
        in: query
        description: The ID of the disk volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - attachVolume
        - createVolume
        - destroyVolume
        - detachVolume
        - importVolume
        - listVolumes
        - migrateVolume
        - recoverVolume
        - resizeVolume
        - updateVolume
        - uploadVolume
      - name: name
        in: query
        description: New name of the volume
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.16'
      - name: path
        in: query
        description: The path of the volume
        schema:
          type: string
          maxLength: 255
      - name: state
        in: query
        description: The state of the volume
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.3'
      - name: storageid
        in: query
        description: Destination storage pool UUID for the volume
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: '4.3'
        x-cloudstack-related:
        - cancelStorageMaintenance
        - createStoragePool
        - enableStorageMaintenance
        - findStoragePoolsForMigration
        - syncStoragePool
      responses:
        '200':
          description: Successful invocation of `updateVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevolumeresponse
      x-cloudstack-command: updateVolume
      x-cloudstack-async: true
      x-cloudstack-related:
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /updateVpnConnection:
    get:
      operationId: updateVpnConnection
      summary: Updates site to site VPN connection
      description: |-
        Updates site to site VPN connection

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnConnection
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVpnConnection
          default: updateVpnConnection
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of VPN connection
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVpnConnection
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the VPN to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateVpnConnection`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpnconnectionresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevpnconnectionresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpnconnectionresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevpnconnectionresponse
      x-cloudstack-command: updateVpnConnection
      x-cloudstack-async: true
      x-cloudstack-since: '4.4'
      x-cloudstack-jobresult-schema: '#/components/schemas/VpnConnection'
  /updateVpnCustomerGateway:
    get:
      operationId: updateVpnCustomerGateway
      summary: Update site to site VPN customer gateway
      description: |-
        Update site to site VPN customer gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnCustomerGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVpnCustomerGateway
          default: updateVpnCustomerGateway
      - $ref: '#/components/parameters/response'
      - name: cidrlist
        in: query
        description: Guest CIDR of the customer gateway. Multiple entries must be separated by a single comma character (,).
        required: true
        schema:
          type: string
          maxLength: 255
      - name: esppolicy
        in: query
        description: ESP policy of the customer gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: gateway
        in: query
        description: Public IP address id of the customer gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: ID of customer gateway
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVpnCustomerGateway
      - name: ikepolicy
        in: query
        description: IKE policy of the customer gateway
        required: true
        schema:
          type: string
          maxLength: 255
      - name: ipsecpsk
        in: query
        description: IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: account
        in: query
        description: The Account associated with the gateway. Must be used with the domainId parameter.
        schema:
          type: string
          maxLength: 255
      - name: domainid
        in: query
        description: The domain ID associated with the gateway. If used with the account parameter returns the gateway associated with the Account for the specified domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: dpd
        in: query
        description: If DPD is enabled for VPN connection
        schema:
          type: boolean
      - name: esplifetime
        in: query
        description: Lifetime of phase 2 VPN connection to the customer gateway, in seconds
        schema:
          type: integer
          format: int64
      - name: forceencap
        in: query
        description: Force encapsulation for Nat Traversal
        schema:
          type: boolean
      - name: ikelifetime
        in: query
        description: Lifetime of phase 1 VPN connection to the customer gateway, in seconds
        schema:
          type: integer
          format: int64
      - name: ikeversion
        in: query
        description: Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2.Connections marked with 'ike' will use 'ikev2' when initiating, but accept any protocol version when responding. Defaults to ike
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.15.1
      - name: name
        in: query
        description: Name of this customer gateway
        schema:
          type: string
          maxLength: 255
      - name: splitconnections
        in: query
        description: For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.
        schema:
          type: boolean
        x-cloudstack-since: 4.15.1
      responses:
        '200':
          description: Successful invocation of `updateVpnCustomerGateway`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpncustomergatewayresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevpncustomergatewayresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpncustomergatewayresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevpncustomergatewayresponse
      x-cloudstack-command: updateVpnCustomerGateway
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/VpnCustomerGateway'
  /updateVpnGateway:
    get:
      operationId: updateVpnGateway
      summary: Updates site to site VPN local gateway
      description: |-
        Updates site to site VPN local gateway

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - VpnGateway
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateVpnGateway
          default: updateVpnGateway
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: ID of customer gateway
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - updateVpnGateway
      - name: customid
        in: query
        description: An optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: '4.4'
      - name: fordisplay
        in: query
        description: An optional field, whether to the display the VPN to the end User or not
        schema:
          type: boolean
        x-cloudstack-since: '4.4'
      responses:
        '200':
          description: Successful invocation of `updateVpnGateway`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpngatewayresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - updatevpngatewayresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatevpngatewayresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatevpngatewayresponse
      x-cloudstack-command: updateVpnGateway
      x-cloudstack-async: true
      x-cloudstack-since: '4.4'
      x-cloudstack-jobresult-schema: '#/components/schemas/VpnGateway'
  /updateWebhook:
    get:
      operationId: updateWebhook
      summary: Updates a Webhook
      tags:
      - Webhook
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateWebhook
          default: updateWebhook
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Webhook
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createWebhook
        - updateWebhook
      - name: description
        in: query
        description: Description for the Webhook
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name for the Webhook
        schema:
          type: string
          maxLength: 255
      - name: payloadurl
        in: query
        description: Payload URL of the Webhook
        schema:
          type: string
          maxLength: 255
      - name: scope
        in: query
        description: Scope of the Webhook
        schema:
          type: string
          maxLength: 255
      - name: secretkey
        in: query
        description: Secret key of the Webhook
        schema:
          type: string
          maxLength: 255
      - name: sslverification
        in: query
        description: If set to true then SSL verification will be done for the Webhook otherwise not
        schema:
          type: boolean
      - name: state
        in: query
        description: State of the Webhook
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `updateWebhook`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatewebhookresponse:
                    oneOf:
                    - &id451
                      $ref: '#/components/schemas/Webhook'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id451
                        - type: array
                          items: *id451
                required:
                - updatewebhookresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatewebhookresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatewebhookresponse
      x-cloudstack-command: updateWebhook
      x-cloudstack-async: false
      x-cloudstack-since: 4.20.0
      x-cloudstack-related:
      - createWebhook
  /updateZone:
    get:
      operationId: updateZone
      summary: Updates a Zone.
      tags:
      - Zone
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: updateZone
          default: updateZone
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Zone
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      - name: allocationstate
        in: query
        description: Allocation state of this cluster for allocation of new resources
        schema:
          type: string
          maxLength: 255
      - name: details
        in: query
        description: The details for the Zone. Map parameter. CloudStack expects it index-encoded as `details[0].key=k&details[0].value=v`.
        x-cloudstack-encoding: indexed-map
        schema:
          type: object
          additionalProperties:
            type: string
          x-cloudstack-type: map
      - name: dhcpprovider
        in: query
        description: The DHCP Provider for the Zone
        schema:
          type: string
          maxLength: 255
      - name: dns1
        in: query
        description: The first DNS for the Zone
        schema:
          type: string
          maxLength: 255
      - name: dns2
        in: query
        description: The second DNS for the Zone
        schema:
          type: string
          maxLength: 255
      - name: dnssearchorder
        in: query
        description: The DNS search order list. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: domain
        in: query
        description: Network domain name for the networks in the zone; empty string will update domain with NULL value
        schema:
          type: string
          maxLength: 255
      - name: guestcidraddress
        in: query
        description: The guest CIDR address for the Zone
        schema:
          type: string
          maxLength: 255
      - name: internaldns1
        in: query
        description: The first internal DNS for the Zone
        schema:
          type: string
          maxLength: 255
      - name: internaldns2
        in: query
        description: The second internal DNS for the Zone
        schema:
          type: string
          maxLength: 255
      - name: ip6dns1
        in: query
        description: The first DNS for IPv6 network in the Zone
        schema:
          type: string
          maxLength: 255
      - name: ip6dns2
        in: query
        description: The second DNS for IPv6 network in the Zone
        schema:
          type: string
          maxLength: 255
      - name: ispublic
        in: query
        description: Updates a private zone to public if set, but not vice-versa
        schema:
          type: boolean
      - name: localstorageenabled
        in: query
        description: True if local storage offering enabled, false otherwise
        schema:
          type: boolean
      - name: name
        in: query
        description: The name of the Zone
        schema:
          type: string
          maxLength: 255
      - name: sortkey
        in: query
        description: Sort key of the zone, integer
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful invocation of `updateZone`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatezoneresponse:
                    oneOf:
                    - &id452
                      $ref: '#/components/schemas/Zone'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id452
                        - type: array
                          items: *id452
                required:
                - updatezoneresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  updatezoneresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - updatezoneresponse
      x-cloudstack-command: updateZone
      x-cloudstack-async: false
      x-cloudstack-related:
      - createZone
      - listZones
  /upgradeKubernetesCluster:
    get:
      operationId: upgradeKubernetesCluster
      summary: Upgrades a running CloudManaged Kubernetes cluster
      description: |-
        Upgrades a running CloudManaged Kubernetes cluster

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - KubernetesCluster
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: upgradeKubernetesCluster
          default: upgradeKubernetesCluster
      - $ref: '#/components/parameters/response'
      - name: id
        in: query
        description: The ID of the Kubernetes cluster
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createKubernetesCluster
        - scaleKubernetesCluster
        - startKubernetesCluster
        - updateKubernetesClusterAffinityGroups
        - upgradeKubernetesCluster
      - name: kubernetesversionid
        in: query
        description: The ID of the Kubernetes version for upgrade
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addKubernetesSupportedVersion
        - getUploadParamsForKubernetesSupportedVersion
        - listKubernetesSupportedVersions
        - updateKubernetesSupportedVersion
      responses:
        '200':
          description: Successful invocation of `upgradeKubernetesCluster`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  upgradekubernetesclusterresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - upgradekubernetesclusterresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  upgradekubernetesclusterresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - upgradekubernetesclusterresponse
      x-cloudstack-command: upgradeKubernetesCluster
      x-cloudstack-async: true
      x-cloudstack-related:
      - createKubernetesCluster
      - scaleKubernetesCluster
      - startKubernetesCluster
      - updateKubernetesClusterAffinityGroups
      x-cloudstack-jobresult-schema: '#/components/schemas/KubernetesCluster'
  /upgradeRouterTemplate:
    get:
      operationId: upgradeRouterTemplate
      summary: Upgrades router to use newer Template
      tags:
      - Template
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: upgradeRouterTemplate
          default: upgradeRouterTemplate
      - $ref: '#/components/parameters/response'
      - name: account
        in: query
        description: Upgrades all routers owned by the specified account
        schema:
          type: string
          maxLength: 255
      - name: clusterid
        in: query
        description: Upgrades all routers within the specified cluster
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addCluster
        - updateCluster
      - name: domainid
        in: query
        description: Upgrades all routers owned by the specified domain
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
      - name: id
        in: query
        description: Upgrades router with the specified Id
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - changeServiceForRouter
        - destroyRouter
        - listInternalLoadBalancerVMs
        - listRouters
        - rebootRouter
        - stopInternalLoadBalancerVM
        - stopNetScalerVpx
        - stopRouter
      - name: podid
        in: query
        description: Upgrades all routers within the specified Pod
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createManagementNetworkIpRange
        - createPod
        - listPods
        - updatePod
      - name: zoneid
        in: query
        description: Upgrades all routers within the specified zone
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createZone
        - listZones
        - updateZone
      responses:
        '200':
          description: Successful invocation of `upgradeRouterTemplate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  upgraderoutertemplateresponse:
                    oneOf:
                    - &id453
                      $ref: '#/components/schemas/CiscoAsa1000vResource'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id453
                        - type: array
                          items: *id453
                required:
                - upgraderoutertemplateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  upgraderoutertemplateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - upgraderoutertemplateresponse
      x-cloudstack-command: upgradeRouterTemplate
      x-cloudstack-async: false
  /uploadCustomCertificate:
    get:
      operationId: uploadCustomCertificate
      summary: Uploads a custom certificate for the console proxy VMs to use for SSL.
      description: |-
        Uploads a custom certificate for the console proxy VMs to use for SSL. Can be used to upload a single certificate signed by a known CA. Can also be used, through multiple calls, to upload a chain of certificates from CA to the custom certificate itself.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Certificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: uploadCustomCertificate
          default: uploadCustomCertificate
      - $ref: '#/components/parameters/response'
      - name: certificate
        in: query
        description: The certificate to be uploaded.
        required: true
        schema:
          type: string
          maxLength: 65535
      - name: domainsuffix
        in: query
        description: DNS domain suffix that the certificate is granted for.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: id
        in: query
        description: An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3
        schema:
          type: integer
          format: int32
      - name: name
        in: query
        description: A name / alias for the certificate.
        schema:
          type: string
          maxLength: 255
      - name: privatekey
        in: query
        description: The private key for the attached certificate.
        schema:
          type: string
          maxLength: 65535
      responses:
        '200':
          description: Successful invocation of `uploadCustomCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadcustomcertificateresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - uploadcustomcertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadcustomcertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - uploadcustomcertificateresponse
      x-cloudstack-command: uploadCustomCertificate
      x-cloudstack-async: true
      x-cloudstack-jobresult-schema: '#/components/schemas/CustomCertificate'
  /uploadResourceIcon:
    get:
      operationId: uploadResourceIcon
      summary: Uploads an icon for the specified resource(s)
      tags:
      - ResourceIcon
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: uploadResourceIcon
          default: uploadResourceIcon
      - $ref: '#/components/parameters/response'
      - name: base64image
        in: query
        description: Base64 string representation of the resource icon/image
        required: true
        schema:
          type: string
          maxLength: 2097152
      - name: resourceids
        in: query
        description: List of resources to upload the icon/image for. List parameter. CloudStack expects the values comma-separated in a single occurrence.
        required: true
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
          x-cloudstack-type: list
      - name: resourcetype
        in: query
        description: Type of the resource
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `uploadResourceIcon`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadresourceiconresponse:
                    oneOf:
                    - &id454
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id454
                        - type: array
                          items: *id454
                required:
                - uploadresourceiconresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadresourceiconresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - uploadresourceiconresponse
      x-cloudstack-command: uploadResourceIcon
      x-cloudstack-async: false
      x-cloudstack-since: 4.16.0.0
  /uploadSslCert:
    get:
      operationId: uploadSslCert
      summary: Upload a certificate to CloudStack
      tags:
      - SslCert
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: uploadSslCert
          default: uploadSslCert
      - $ref: '#/components/parameters/response'
      - name: certificate
        in: query
        description: SSL certificate
        required: true
        schema:
          type: string
          maxLength: 16384
      - name: name
        in: query
        description: Name for the uploaded certificate
        required: true
        schema:
          type: string
          maxLength: 255
      - name: privatekey
        in: query
        description: Private key
        required: true
        schema:
          type: string
          maxLength: 16384
      - name: account
        in: query
        description: Account that will own the SSL certificate
        schema:
          type: string
          maxLength: 255
      - name: certchain
        in: query
        description: Certificate chain of trust
        schema:
          type: string
          maxLength: 2097152
      - name: domainid
        in: query
        description: Domain ID of the account owning the SSL certificate
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
        - moveDomain
      - name: enabledrevocationcheck
        in: query
        description: Enables revocation checking for certificates
        schema:
          type: boolean
        x-cloudstack-since: '4.15'
      - name: password
        in: query
        description: Password for the private key
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: An optional project for the SSL certificate
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `uploadSslCert`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadsslcertresponse:
                    oneOf:
                    - &id455
                      $ref: '#/components/schemas/SslCert'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id455
                        - type: array
                          items: *id455
                required:
                - uploadsslcertresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadsslcertresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - uploadsslcertresponse
      x-cloudstack-command: uploadSslCert
      x-cloudstack-async: false
  /uploadTemplateDirectDownloadCertificate:
    get:
      operationId: uploadTemplateDirectDownloadCertificate
      summary: Upload a certificate for HTTPS direct Template download on KVM hosts
      tags:
      - TemplateDirectDownloadCertificate
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: uploadTemplateDirectDownloadCertificate
          default: uploadTemplateDirectDownloadCertificate
      - $ref: '#/components/parameters/response'
      - name: certificate
        in: query
        description: SSL certificate
        required: true
        schema:
          type: string
          maxLength: 65535
      - name: hypervisor
        in: query
        description: Hypervisor type
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: Name for the uploaded certificate
        required: true
        schema:
          type: string
          maxLength: 255
      - name: zoneid
        in: query
        description: Zone to upload certificate
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: hostid
        in: query
        description: (Optional) the host ID to upload certificate
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - addBaremetalHost
        - declareHostAsDegraded
        - listHosts
        - reconnectHost
      responses:
        '200':
          description: Successful invocation of `uploadTemplateDirectDownloadCertificate`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadtemplatedirectdownloadcertificateresponse:
                    oneOf:
                    - &id456
                      $ref: '#/components/schemas/TemplateDirectDownloadCertificate'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id456
                        - type: array
                          items: *id456
                required:
                - uploadtemplatedirectdownloadcertificateresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadtemplatedirectdownloadcertificateresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - uploadtemplatedirectdownloadcertificateresponse
      x-cloudstack-command: uploadTemplateDirectDownloadCertificate
      x-cloudstack-async: false
      x-cloudstack-since: 4.11.0
      x-cloudstack-related:
      - listTemplateDirectDownloadCertificates
  /uploadVolume:
    get:
      operationId: uploadVolume
      summary: Uploads a data disk.
      description: |-
        Uploads a data disk.

        This command is asynchronous: it returns a `jobid`. The documented entity is delivered in the `jobresult` of `queryAsyncJobResult`.
      tags:
      - Volume
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: uploadVolume
          default: uploadVolume
      - $ref: '#/components/parameters/response'
      - name: format
        in: query
        description: The format for the volume. Possible values include QCOW2, OVA, and VHD.
        required: true
        schema:
          type: string
          maxLength: 255
      - name: name
        in: query
        description: The name of the volume
        required: true
        schema:
          type: string
          maxLength: 255
      - name: url
        in: query
        description: The URL of where the volume is hosted. Possible URL include http:// and https://
        required: true
        schema:
          type: string
          maxLength: 2048
      - name: zoneid
        in: query
        description: The ID of the zone the volume is to be hosted on
        required: true
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - listZones
      - name: account
        in: query
        description: An optional accountName. Must be used with domainId.
        schema:
          type: string
          maxLength: 255
      - name: checksum
        in: query
        description: |-
          The checksum value of this volume. The parameter containing the checksum will be considered a MD5sum if it is not prefixed
           and just a plain ascii/utf8 representation of a hexadecimal string. If it is required to
           use another algorithm the hexadecimal string is to be prefixed with a string of the form,
           "{<algorithm>}", not including the double quotes. In this <algorithm> is the exact string
           representing the java supported algorithm, i.e. MD5 or SHA-256. Note that java does not
           contain an algorithm called SHA256 or one called sha-256, only SHA-256.
        schema:
          type: string
          maxLength: 255
      - name: diskofferingid
        in: query
        description: The ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.
        schema:
          type: string
          format: uuid
          maxLength: 255
      - name: domainid
        in: query
        description: An optional domainId. If the Account parameter is used, domainId must also be used. If Account is NOT provided then volume will be assigned to the caller Account and domain.
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createDomain
        - listDomains
      - name: imagestoreuuid
        in: query
        description: Image store uuid
        schema:
          type: string
          maxLength: 255
      - name: projectid
        in: query
        description: Upload volume for the project
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-related:
        - createProject
      responses:
        '200':
          description: Successful invocation of `uploadVolume`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadvolumeresponse:
                    $ref: '#/components/schemas/AsyncJobStart'
                required:
                - uploadvolumeresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  uploadvolumeresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - uploadvolumeresponse
      x-cloudstack-command: uploadVolume
      x-cloudstack-async: true
      x-cloudstack-related:
      - assignVolume
      - attachVolume
      - createVolume
      - destroyVolume
      - detachVolume
      - importVolume
      - listVolumes
      - migrateVolume
      - recoverVolume
      - resizeVolume
      - updateVolume
      - uploadVolume
      x-cloudstack-jobresult-schema: '#/components/schemas/Volume'
  /validateUserTwoFactorAuthenticationCode:
    get:
      operationId: validateUserTwoFactorAuthenticationCode
      summary: Checks the 2FA code for the user.
      tags:
      - UserTwoFactorAuthenticationCode
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: validateUserTwoFactorAuthenticationCode
          default: validateUserTwoFactorAuthenticationCode
      - $ref: '#/components/parameters/response'
      - name: codefor2fa
        in: query
        description: Two factor authentication code
        required: true
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `validateUserTwoFactorAuthenticationCode`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  validateusertwofactorauthenticationcoderesponse:
                    oneOf:
                    - &id457
                      $ref: '#/components/schemas/SuccessResult'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id457
                        - type: array
                          items: *id457
                required:
                - validateusertwofactorauthenticationcoderesponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  validateusertwofactorauthenticationcoderesponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - validateusertwofactorauthenticationcoderesponse
      x-cloudstack-command: validateUserTwoFactorAuthenticationCode
      x-cloudstack-async: false
      x-cloudstack-since: 4.18.0
  /verifyOAuthCodeAndGetUser:
    get:
      operationId: verifyOAuthCodeAndGetUser
      summary: Verify the OAuth Code and fetch the corresponding user from provider
      tags:
      - OAuthCodeAndGetUser
      parameters:
      - name: command
        in: query
        description: API command to invoke.
        required: true
        schema:
          type: string
          const: verifyOAuthCodeAndGetUser
          default: verifyOAuthCodeAndGetUser
      - $ref: '#/components/parameters/response'
      - name: provider
        in: query
        description: Name of the provider
        required: true
        schema:
          type: string
          maxLength: 255
      - name: domain
        in: query
        description: Domain path for domain-specific OAuth provider lookup. Ignored when Domain ID is passed.
        schema:
          type: string
          maxLength: 255
        x-cloudstack-since: 4.23.0
      - name: domainid
        in: query
        description: Domain ID for domain-specific OAuth provider lookup. If not provided, uses global provider
        schema:
          type: string
          format: uuid
          maxLength: 255
        x-cloudstack-since: 4.23.0
        x-cloudstack-related:
        - createDomain
        - listDomainChildren
        - listDomains
        - moveDomain
        - updateDomain
      - name: keyword
        in: query
        description: List by keyword
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        schema:
          type: integer
          format: int32
      - name: pagesize
        in: query
        schema:
          type: integer
          format: int32
      - name: secretcode
        in: query
        description: Code that is provided by OAuth provider (Eg. google, github) after successful login
        schema:
          type: string
          maxLength: 255
      responses:
        '200':
          description: Successful invocation of `verifyOAuthCodeAndGetUser`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  verifyoauthcodeandgetuserresponse:
                    oneOf:
                    - &id458
                      $ref: '#/components/schemas/OauthProvider'
                    - type: object
                      properties:
                        count:
                          type: integer
                          description: Total number of matching entities.
                      additionalProperties:
                        oneOf:
                        - *id458
                        - type: array
                          items: *id458
                required:
                - verifyoauthcodeandgetuserresponse
        default:
          description: CloudStack error. The HTTP status repeats the `errorcode` of the body.
          content:
            application/json:
              schema:
                type: object
                properties:
                  verifyoauthcodeandgetuserresponse:
                    $ref: '#/components/schemas/CloudStackError'
                required:
                - verifyoauthcodeandgetuserresponse
      x-cloudstack-command: verifyOAuthCodeAndGetUser
      x-cloudstack-async: false
      x-cloudstack-since: 4.19.0
      x-cloudstack-related:
      - updateOauthProvider
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: apiKey
      description: API key of the CloudStack user. Must be sent together with `signature`.
    signature:
      type: apiKey
      in: query
      name: signature
      description: Base64-encoded HMAC-SHA1 of the lower-cased, alphabetically sorted, URL-encoded query string, signed with the user's secret key.
    sessionKey:
      type: apiKey
      in: query
      name: sessionkey
      description: Session key obtained from `login`, used instead of `apiKey` plus `signature`.
  parameters:
    response:
      name: response
      in: query
      description: Format of the response body. This document only describes the JSON rendering.
      required: false
      schema:
        type: string
        enum:
        - json
        - xml
        default: json
    page:
      name: page
      in: query
      description: Page to return, used together with `pagesize`.
      required: false
      schema:
        type: integer
        format: int32
        minimum: 1
  schemas:
    CloudStackError:
      type: object
      description: Error body CloudStack returns in place of the documented payload.
      properties:
        errorcode:
          type: integer
          description: Error code, mirrored in the HTTP status.
        cserrorcode:
          type: integer
          description: CloudStack specific error code.
        errortext:
          type: string
          description: Human readable error message.
        uuidList:
          type: array
          description: UUIDs of the entities the error refers to.
          items:
            type: object
    AsyncJobStart:
      type: object
      description: Acknowledgement of an asynchronous command. Poll `queryAsyncJobResult` with `jobid` to obtain the documented payload.
      properties:
        jobid:
          type: string
          format: uuid
          description: ID of the async job.
        id:
          type: string
          description: ID of the entity the job acts on, when already known.
      additionalProperties: true
    ASNRange:
      type: object
      properties:
        created:
          type: string
          x-cloudstack-type: date
          description: Created date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        endasn:
          type: integer
          format: int64
          description: End AS Number
        id:
          type: string
          description: ID of the AS Number Range
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        startasn:
          type: integer
          format: int64
          description: Start AS Number
        zoneid:
          type: string
          description: Zone ID
    ASNumber:
      type: object
      properties:
        account:
          type: string
          description: the account name
        accountid:
          type: string
          description: Account ID
        allocated:
          type: string
          x-cloudstack-type: date
          description: Allocated Date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        allocationstate:
          type: string
          description: Allocation state
        asnrange:
          type: string
          description: AS Number Range
        asnrangeid:
          type: string
          description: AS Number ID
        asnumber:
          type: integer
          format: int64
          description: AS Number
        associatednetworkid:
          type: string
          description: Network ID
        associatednetworkname:
          type: string
          description: Network Name
        created:
          type: string
          x-cloudstack-type: date
          description: Created Date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: the domain name
        domainid:
          type: string
          description: Domain ID
        id:
          type: string
          description: ID of the AS Number
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        vpcid:
          type: string
          description: VPC ID
        vpcname:
          type: string
          description: VPC Name
        zoneid:
          type: string
          description: Zone ID
        zonename:
          type: string
          description: the zone name of the AS Number range
    Account:
      type: object
      properties:
        accountdetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Details for the account
        accounttype:
          type: integer
          format: int32
          description: Account type (admin, domain-admin, user)
        apikeyaccess:
          type: string
          x-cloudstack-type: apikeyaccess
          description: whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
        backupavailable:
          type: string
          description: the total number of backups available to this account
        backuplimit:
          type: string
          description: the total number of backups which can be stored by this account
        backupstorageavailable:
          type: string
          description: the total backup storage space (in GiB) available to the account
        backupstoragelimit:
          type: string
          description: the total backup storage space (in GiB) the account can own
        backupstoragetotal:
          type: integer
          format: int64
          description: the total backup storage space (in GiB) owned by the account
        backuptotal:
          type: integer
          format: int64
          description: the total number of backups stored by this account
        bucketavailable:
          type: string
          description: the total number of buckets available to this account
        bucketlimit:
          type: string
          description: the total number of buckets which can be stored by this account
        buckettotal:
          type: integer
          format: int64
          description: the total number of buckets stored by this account
        cpuavailable:
          type: string
          description: The total number of CPU cores available to be created for this account
        cpulimit:
          type: string
          description: The total number of CPU cores the account can own
        cputotal:
          type: integer
          format: int64
          description: The total number of CPU cores owned by account
        created:
          type: string
          x-cloudstack-type: date
          description: The date when this account was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        defaultzoneid:
          type: string
          description: The default zone of the Account
        domain:
          type: string
          description: Name of the Domain the Account belongs to
        domainid:
          type: string
          description: ID of the Domain the Account belongs to
        domainpath:
          type: string
          description: Path of the Domain the Account belongs to
        gpuavailable:
          type: string
          description: the total number of gpus available to be created for this account
        gpulimit:
          type: string
          description: the total number of gpus the account can own
        gputotal:
          type: integer
          format: int64
          description: the total number of gpus owned by account
        groups:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of ACL groups that account belongs to
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The ID of the Account
        ipavailable:
          type: string
          description: The total number of public IP addresses available for this Account to acquire
        iplimit:
          type: string
          description: The total number of public IP addresses this Account can acquire
        iptotal:
          type: integer
          format: int64
          description: The total number of public IP addresses allocated for this Account
        iscleanuprequired:
          type: boolean
          description: True if the account requires cleanup
        isdefault:
          type: boolean
          description: True if account is default, false otherwise
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        memoryavailable:
          type: string
          description: The total memory (in MB) available to be created for this account
        memorylimit:
          type: string
          description: The total memory (in MB) the account can own
        memorytotal:
          type: integer
          format: int64
          description: The total memory (in MB) owned by account
        name:
          type: string
          description: The name of the Account
        networkavailable:
          type: string
          description: The total number of Networks available to be created for this Account
        networkdomain:
          type: string
          description: The Network domain
        networklimit:
          type: string
          description: The total number of Networks the Account can own
        networktotal:
          type: integer
          format: int64
          description: The total number of Networks owned by Account
        objectstorageavailable:
          type: string
          description: the total object storage space (in GiB) available to the account
        objectstoragelimit:
          type: string
          description: the total object storage space (in GiB) the account can own
        objectstoragetotal:
          type: integer
          format: int64
          description: the total object storage space (in GiB) owned by the account
        primarystorageavailable:
          type: string
          description: The total primary storage space (in GiB) available to be used for this account
        primarystoragelimit:
          type: string
          description: The total primary storage space (in GiB) the account can own
        primarystoragetotal:
          type: integer
          format: int64
          description: The total primary storage space (in GiB) owned by account
        projectavailable:
          type: string
          description: The total number of projects available for administration by this Account
        projectlimit:
          type: string
          description: The total number of projects the Account can own
        projecttotal:
          type: integer
          format: int64
          description: The total number of projects being administrated by this Account
        receivedbytes:
          type: integer
          format: int64
          description: The total number of Network traffic bytes received
        roleid:
          type: string
          description: The ID of the role
        rolename:
          type: string
          description: The name of the role
        roletype:
          type: string
          description: The type of the role (Admin, ResourceAdmin, DomainAdmin, User)
        secondarystorageavailable:
          type: string
          description: The total secondary storage space (in GiB) available to be used for this account
        secondarystoragelimit:
          type: string
          description: The total secondary storage space (in GiB) the account can own
        secondarystoragetotal:
          type: number
          format: float
          description: The total secondary storage space (in GiB) owned by account
        sentbytes:
          type: integer
          format: int64
          description: The total number of Network traffic bytes sent
        snapshotavailable:
          type: string
          description: The total number of Snapshots available for this Account
        snapshotlimit:
          type: string
          description: The total number of Snapshots which can be stored by this Account
        snapshottotal:
          type: integer
          format: int64
          description: The total number of Snapshots stored by this Account
        state:
          type: string
          description: The state of the account
        taggedresources:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The tagged resource limit and count for the account
        templateavailable:
          type: string
          description: The total number of Templates available to be created by this Account
        templatelimit:
          type: string
          description: The total number of Templates which can be created by this Account
        templatetotal:
          type: integer
          format: int64
          description: The total number of Templates which have been created by this Account
        user:
          type: array
          items:
            $ref: '#/components/schemas/User'
          x-cloudstack-type: list
          description: The list of users associated with account
        vmavailable:
          type: string
          description: The total number of Instances available for this Account to acquire
        vmlimit:
          type: string
          description: The total number of Instances that can be deployed by this Account
        vmrunning:
          type: integer
          format: int32
          description: The total number of Instances running for this Account
        vmstopped:
          type: integer
          format: int32
          description: The total number of Instances stopped for this Account
        vmtotal:
          type: integer
          format: int64
          description: The total number of Instances deployed by this Account
        volumeavailable:
          type: string
          description: The total volume available for this Account
        volumelimit:
          type: string
          description: The total volume which can be used by this Account
        volumetotal:
          type: integer
          format: int64
          description: The total volume being used by this Account
        vpcavailable:
          type: string
          description: The total number of VPCs available to be created for this account
        vpclimit:
          type: string
          description: The total number of VPCs the Account can own
        vpctotal:
          type: integer
          format: int64
          description: The total number of VPCs owned by account
    AccountAllowedToCreateOfferingsWithTag:
      type: object
      properties:
        isallowed:
          type: boolean
          description: Is domain admin allowed to create offerings with tags
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    AcquirePodIpAddress:
      type: object
      properties:
        cidr:
          type: string
          description: CIDR of the Pod
        gateway:
          type: string
          description: Gateway for Pod
        hostmac:
          type: integer
          format: int64
          description: MAC address of the pod the IP
        id:
          type: integer
          format: int64
          description: The ID of the pod the IP address
        ipaddress:
          type: string
          description: Allocated IP address
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        nicid:
          type: integer
          format: int64
          description: The ID of the NIC
        podid:
          type: integer
          format: int64
          description: The ID of the pod the  IP address belongs to
    AffectedVmsForStorageScopeChange:
      type: object
      properties:
        clusterid:
          type: string
          description: the cluster ID for the VM
        clustername:
          type: string
          description: the cluster name for the VM
        hostid:
          type: string
          description: the host ID for the VM
        hostname:
          type: string
          description: the hostname for the VM
        id:
          type: string
          description: the ID of the VM
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: the name of the VM
        type:
          type: string
          description: the type of VM
    AffinityGroup:
      type: object
      properties:
        account:
          type: string
          description: The account owning the affinity group
        dedicatedresources:
          type: array
          items: {}
          x-cloudstack-type: list
          description: dedicated resources associated with this affinity group
        description:
          type: string
          description: The description of the affinity group
        domain:
          type: string
          description: The domain name of the affinity group
        domainid:
          type: string
          description: The domain ID of the affinity group
        domainpath:
          type: string
          description: path of the Domain the affinity group belongs to
        id:
          type: string
          description: The ID of the affinity group
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the affinity group
        project:
          type: string
          description: The project name of the affinity group
        projectid:
          type: string
          description: The project ID of the affinity group
        type:
          type: string
          description: The type of the affinity group
        virtualmachineIds:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Instance IDs associated with this affinity group
    AffinityGroupType:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        type:
          type: string
          description: The type of the affinity group
    Affinitygroup:
      type: object
      properties:
        account:
          type: string
          description: The account owning the affinity group
        dedicatedresources:
          type: array
          items: {}
          x-cloudstack-type: list
          description: dedicated resources associated with this affinity group
        description:
          type: string
          description: The description of the affinity group
        domain:
          type: string
          description: The domain name of the affinity group
        domainid:
          type: string
          description: The domain ID of the affinity group
        domainpath:
          type: string
          description: path of the Domain the affinity group belongs to
        id:
          type: string
          description: The ID of the affinity group
        name:
          type: string
          description: The name of the affinity group
        project:
          type: string
          description: The project name of the affinity group
        projectid:
          type: string
          description: The project ID of the affinity group
        type:
          type: string
          description: The type of the affinity group
        virtualmachineIds:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Instance IDs associated with this affinity group
    Annotation:
      type: object
      properties:
        adminsonly:
          type: boolean
          description: True if the annotation is available for admins only
        annotation:
          type: string
          description: The contents of the annotation
        created:
          type: string
          x-cloudstack-type: date
          description: The creation timestamp for this annotation. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        entityid:
          type: string
          description: The UUID of the entity to which this annotation pertains
        entityname:
          type: string
          description: The name of the entity to which this annotation pertains
        entitytype:
          type: string
          description: The type of the annotated entity
        id:
          type: string
          description: The UUID of the annotation
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        removed:
          type: string
          x-cloudstack-type: date
          description: The removal timestamp for this annotation. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        userid:
          type: string
          description: The UUID of the User that entered the annotation
        username:
          type: string
          description: The username of the User that entered the annotation
    Api:
      type: object
      properties:
        description:
          type: string
          description: Description of the API
        httprequesttype:
          type: string
          description: Preferred HTTP request type for the API
        isasync:
          type: boolean
          description: True if API is asynchronous
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the API command
        params:
          type: array
          items:
            $ref: '#/components/schemas/Params'
          x-cloudstack-type: set
          description: The list params the api accepts
        related:
          type: string
          description: Comma separated related apis
        response:
          type: array
          items:
            $ref: '#/components/schemas/Response'
          x-cloudstack-type: set
          description: API response fields
        since:
          type: string
          description: Version of CloudStack the API was introduced in
        type:
          type: string
          description: Response field type
    ApiLimit:
      type: object
      properties:
        account:
          type: string
          description: The Account name of the api remaining count
        accountid:
          type: string
          description: The Account UUID of the api remaining count
        apiAllowed:
          type: integer
          format: int32
          description: Currently allowed number of APIs
        apiIssued:
          type: integer
          format: int32
          description: Number of API already issued
        expireAfter:
          type: integer
          format: int64
          description: Seconds left to reset counters
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    AssociateUcsProfileToBladeResult:
      type: object
      properties:
        bladedn:
          type: string
          description: UCS blade dn
        hostid:
          type: string
          description: CloudStack host ID this blade associates to
        id:
          type: string
          description: UCS blade ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        profiledn:
          type: string
          description: Associated UCS profile dn
        ucsmanagerid:
          type: string
          description: UCS manager ID
    AuthorizeSecurityGroupEgressResult:
      type: object
      properties:
        account:
          type: string
          description: Account owning the security group rule
        cidr:
          type: string
          description: The CIDR notation for the base IP address of the security group rule
        endport:
          type: integer
          format: int32
          description: The ending IP of the security group rule
        icmpcode:
          type: integer
          format: int32
          description: The code for the ICMP message response
        icmptype:
          type: integer
          format: int32
          description: The type of the ICMP message response
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        protocol:
          type: string
          description: The protocol of the security group rule
        ruleid:
          type: string
          description: The ID of the security group rule
        securitygroupname:
          type: string
          description: Security group name
        startport:
          type: integer
          format: int32
          description: The starting IP of the security group rule
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated with the rule
    AutoScalePolicy:
      type: object
      properties:
        account:
          type: string
          description: The Account owning the autoscale policy
        action:
          type: string
          description: The action to be executed if all the conditions evaluate to true for the specified duration.
        conditions:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of IDs of the conditions that are being evaluated on every interval
        domain:
          type: string
          description: The domain name of the autoscale policy
        domainid:
          type: string
          description: The domain ID of the autoscale policy
        domainpath:
          type: string
          description: path of the domain to which the autoscale policy belongs
        duration:
          type: integer
          format: int32
          description: The duration for which the conditions have to be true before action is taken
        id:
          type: string
          description: The autoscale policy ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the autoscale policy
        project:
          type: string
          description: The project name of the autoscale policy
        projectid:
          type: string
          description: The project id autoscale policy
        quiettime:
          type: integer
          format: int32
          description: The cool down period for which the policy should not be evaluated after the action has been taken
    AutoScaleVmGroup:
      type: object
      properties:
        account:
          type: string
          description: The Account owning the Instance group
        associatednetworkid:
          type: string
          description: The id of the guest Network the LB rule belongs to
        associatednetworkname:
          type: string
          description: The name of the guest Network the LB rule belongs to
        availablevirtualmachinecount:
          type: integer
          format: int32
          description: The number of available Instances (in Running, Starting, Stopping or Migrating state) in the Instance Group
        created:
          type: string
          x-cloudstack-type: date
          description: The date when this Instance group was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: The domain name of the Instance group
        domainid:
          type: string
          description: The domain ID of the Instance group
        domainpath:
          type: string
          description: path of the domain to which the vm group belongs
        fordisplay:
          type: boolean
          description: Is group for display to the regular User
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The autoscale Instance group ID
        interval:
          type: integer
          format: int32
          description: The frequency at which the conditions have to be evaluated
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lbprovider:
          type: string
          description: The LB provider of the guest Network the LB rule belongs to
        lbruleid:
          type: string
          description: The Load balancer rule ID
        maxmembers:
          type: integer
          format: int32
          description: The maximum number of members in the Instance Group, The number of Instances in the Instance group will be equal to or less than this number.
        minmembers:
          type: integer
          format: int32
          description: The minimum number of members in the Instance Group, the number of Instances in the Instance group will be equal to or more than this number.
        name:
          type: string
          description: The name of the autoscale Instance group
        privateport:
          type: string
          description: The private port
        project:
          type: string
          description: The project name of the Instance group
        projectid:
          type: string
          description: The project id of the Instance group
        publicip:
          type: string
          description: The public IP address
        publicipid:
          type: string
          description: The public IP address ID
        publicport:
          type: string
          description: The public port
        scaledownpolicies:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List of scaledown autoscale policies
        scaleuppolicies:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List of scaleup autoscale policies
        state:
          type: string
          description: The current state of the AutoScale Instance Group
        vmprofileid:
          type: string
          description: The autoscale profile that contains information about the Instances in the Instance group.
    AutoScaleVmProfile:
      type: object
      properties:
        account:
          type: string
          description: The Account owning the Instance group
        autoscaleuserid:
          type: string
          description: The ID of the User used to launch and destroy the Instances
        domain:
          type: string
          description: The domain name of the Instance profile
        domainid:
          type: string
          description: The domain ID of the Instance profile
        domainpath:
          type: string
          description: path of the domain to which the vm profile belongs
        expungevmgraceperiod:
          type: integer
          format: int32
          description: The time allowed for existing connections to get closed before an Instance is destroyed
        fordisplay:
          type: boolean
          description: Is profile for display to the regular User
        id:
          type: string
          description: The autoscale Instance profile ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        otherdeployparams:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Parameters other than zoneId/serviceOfferringId/templateId to be used while deploying an Instance
        project:
          type: string
          description: The project name of the Instance profile
        projectid:
          type: string
          description: The project id Instance profile
        serviceofferingid:
          type: string
          description: The service offering to be used while deploying an Instance
        templateid:
          type: string
          description: The Template to be used while deploying an Instance
        userdata:
          type: string
          description: Base64 encoded Instance user data
        userdatadetails:
          type: string
          description: list of variables and values for the variables declared in userdata
        userdataid:
          type: string
          description: the id of userdata used for the VM
        userdataname:
          type: string
          description: the name of userdata used for the VM
        userdatapolicy:
          type: string
          description: the userdata override policy with the userdata provided while deploying VM
        zoneid:
          type: string
          description: The availability zone to be used while deploying an Instance
    BackupOffering:
      type: object
      properties:
        allowuserdrivenbackups:
          type: boolean
          description: Whether the offering allows User driven ad-hoc/scheduled backups
        backupofferingdetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Details for the backup offering
        created:
          type: string
          x-cloudstack-type: date
          description: The date this backup offering was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        crosszoneinstancecreation:
          type: boolean
          description: the backups with this offering can be used to create Instances on all Zones
        description:
          type: string
          description: Description for the backup offering
        domain:
          type: string
          description: the domain name(s) this backup offering belongs to.
        domainid:
          type: string
          description: the domain ID(s) this backup offering belongs to.
        externalid:
          type: string
          description: External ID on the provider side
        id:
          type: string
          description: ID of the backup offering
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name for the backup offering
        provider:
          type: string
          description: provider name
        zoneid:
          type: string
          description: Zone ID
        zonename:
          type: string
          description: Zone name
    BackupRepository:
      type: object
      properties:
        address:
          type: string
          description: the address / url of the backup repository
        capacitybytes:
          type: integer
          format: int64
          description: capacity of the backup repository
        created:
          type: string
          x-cloudstack-type: date
          description: the date and time the backup repository was added. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        crosszoneinstancecreation:
          type: boolean
          description: the backups in this repository can be used to create Instances on all Zones
        id:
          type: string
          description: the ID of the backup repository
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        mountopts:
          type: string
          description: mount options
        name:
          type: string
          description: the name of the backup repository
        provider:
          type: string
          description: name of the provider
        type:
          type: string
          description: backup type
        zoneid:
          type: string
          description: the Zone ID of the backup repository
        zonename:
          type: string
          description: the Zone name of the backup repository
    BackupSchedule:
      type: object
      properties:
        id:
          type: string
          description: ID of the backup schedule.
        intervaltype:
          type: string
          x-cloudstack-type: intervaltype
          description: The interval type of the backup schedule
        isolated:
          type: boolean
          description: Whether the backup will be isolated, defaults to false. Isolated backups are always created as full backups in independent chains. Therefore, they will never depend on any existing backup chain and no backup chain will depend on them. Currently only supported for the KBOSS provider.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        maxbackups:
          type: integer
          format: int32
          description: maximum number of backups retained
        quiescevm:
          type: boolean
          description: quiesce the instance before checkpointing the disks for backup
        schedule:
          type: string
          description: The time the backup is scheduled to be taken.
        timezone:
          type: string
          description: The time zone of the backup schedule
        virtualmachineid:
          type: string
          description: ID of the Instance
        virtualmachinename:
          type: string
          description: Name of the Instance
    BackupServiceJob:
      type: object
      properties:
        attempts:
          type: integer
          format: int32
          description: Number of attempts already made to complete this job.
        backupid:
          type: string
          description: Backup ID.
        hostid:
          type: string
          description: Host where the job is being executed.
        id:
          type: integer
          format: int64
          description: Compression job ID.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        removed:
          type: string
          x-cloudstack-type: date
          description: Compression job scheduled removed date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        scheduleddate:
          type: string
          x-cloudstack-type: date
          description: Compression job scheduled start date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        startdate:
          type: string
          x-cloudstack-type: date
          description: Compression job start date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        type:
          type: string
          description: Compression job type.
        zoneid:
          type: string
          description: Zone where the job is being executed.
    BaremetalDhcp:
      type: object
      properties:
        dhcpservertype:
          type: string
          description: Name of the provider
        id:
          type: string
          description: Device ID of
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        physicalnetworkid:
          type: string
          description: The physical network to which this external dhcp device belongs to
        provider:
          type: string
          description: Name of the provider
        url:
          type: string
          description: URL
    BaremetalPxeKickStartServer:
      type: object
      properties:
        id:
          type: string
          description: Device ID of
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        physicalnetworkid:
          type: string
          description: The physical Network to which this external DHCP device belongs to
        provider:
          type: string
          description: Name of the provider
        tftpdir:
          type: string
          description: Tftp root directory of PXE server
        url:
          type: string
          description: URL
    BaremetalPxePingServer:
      type: object
      properties:
        id:
          type: string
          description: Device ID of
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        physicalnetworkid:
          type: string
          description: The physical Network to which this external DHCP device belongs to
        pingdir:
          type: string
          description: Root directory on PING storage server
        pingstorageserverip:
          type: string
          description: PING storage server ip
        provider:
          type: string
          description: Name of the provider
        tftpdir:
          type: string
          description: Tftp root directory of PXE server
        url:
          type: string
          description: URL
    BaremetalPxeServer:
      type: object
      properties:
        id:
          type: string
          description: Device ID of
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        physicalnetworkid:
          type: string
          description: The physical Network to which this external DHCP device belongs to
        provider:
          type: string
          description: Name of the provider
        url:
          type: string
          description: URL
    BaremetalRct:
      type: object
      properties:
        id:
          type: string
          description: ID of RCT
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        url:
          type: string
          description: URL
    BgpPeer:
      type: object
      properties:
        account:
          type: string
          description: the account of the bgp peer
        asnumber:
          type: integer
          format: int64
          description: AS number of bgp peer
        created:
          type: string
          x-cloudstack-type: date
          description: date when this bgp peer was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: additional key/value details of the bgp peer
        domain:
          type: string
          description: the domain name of the bgp peer
        domainid:
          type: string
          description: the domain ID of the bgp peer
        id:
          type: string
          description: id of the bgp peer
        ip6address:
          type: string
          description: IPv6 address of bgp peer
        ipaddress:
          type: string
          description: IPv4 address of bgp peer
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        password:
          type: string
          description: password of bgp peer
        project:
          type: string
          description: the project name of the bgp peer
        projectid:
          type: string
          description: the project id of the bgp peer
        zoneid:
          type: string
          description: id of zone to which the bgp peer belongs to.
        zonename:
          type: string
          description: name of zone to which the bgp peer belongs to.
    BigSwitchBcfDevice:
      type: object
      properties:
        bcfdeviceid:
          type: string
          description: Device ID of the BigSwitch BCF Controller
        bigswitchdevicename:
          type: string
          description: Device name
        hostname:
          type: string
          description: The controller IP address
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        nat:
          type: boolean
          description: NAT support
        password:
          type: string
          description: The controller password
        physicalnetworkid:
          type: string
          description: The physical Network to which this BigSwitch BCF segment belongs to
        provider:
          type: string
          description: Name of the provider
        username:
          type: string
          description: The controller username
    BrocadeVcsDevice:
      type: object
      properties:
        brocadedevicename:
          type: string
          description: Device name
        hostname:
          type: string
          description: The principal switch IP address
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        physicalnetworkid:
          type: string
          description: The physical Network to which this Brocade VCS belongs to
        provider:
          type: string
          description: Name of the provider
        vcsdeviceid:
          type: string
          description: Device ID of the Brocade Vcs
    Bucket:
      type: object
      properties:
        accesskey:
          type: string
          description: Bucket Access Key
        account:
          type: string
          description: the account associated with the Bucket
        created:
          type: string
          x-cloudstack-type: date
          description: the date the Bucket was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: the domain associated with the bucket
        domainid:
          type: string
          description: the ID of the domain associated with the bucket
        domainpath:
          type: string
          description: path of the domain to which the bucket belongs
        encryption:
          type: boolean
          description: Bucket Encryption
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: ID of the Bucket
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: name of the Bucket
        objectlocking:
          type: boolean
          description: Bucket Object Locking
        objectstorageid:
          type: string
          description: id of the object storage hosting the Bucket; returned to admin user only
        objectstore:
          type: string
          description: Name of the object storage hosting the Bucket; returned to admin user only
        policy:
          type: string
          description: Bucket Access Policy
        project:
          type: string
          description: the project name of the bucket
        projectid:
          type: string
          description: the project id of the bucket
        provider:
          type: string
          description: Object storage provider
        quota:
          type: integer
          format: int32
          description: Bucket Quota in GiB
        size:
          type: integer
          format: int64
          description: Total size of objects in Bucket
        state:
          type: string
          description: State of the Bucket
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        url:
          type: string
          description: Bucket URL
        usersecretkey:
          type: string
          description: Bucket Secret Key
        versioning:
          type: boolean
          description: Bucket Versioning
    CancelMaintenanceResult:
      type: object
      properties:
        agents:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The host agents this management server is responsible for
        agentscount:
          type: integer
          format: int64
          description: The number of host agents this management server is responsible for
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        maintenanceinitiated:
          type: boolean
          description: Indicates whether maintenance has been initiated
        managementserverid:
          type: string
          description: The id of the management server
        pendingjobscount:
          type: integer
          format: int64
          description: The number of jobs in progress
        readyforshutdown:
          type: boolean
          description: Indicates whether CloudStack is ready to shutdown
        shutdowntriggered:
          type: boolean
          description: Indicates whether a shutdown has been triggered
        state:
          type: string
          x-cloudstack-type: state
          description: the state of the management server
    Capability:
      type: object
      properties:
        canchooseservicecapability:
          type: boolean
          description: Can this service capability value can be choosable while creatine Network offerings
        name:
          type: string
          description: The capability name
        value:
          type: string
          description: The capability value
    Capability2:
      type: object
      properties:
        additionalconfigenabled:
          type: boolean
          description: true if additional configurations or extraconfig can be passed to Instances
        allowusercreateprojects:
          type: boolean
          description: True if regular User is allowed to create projects
        allowuserexpungerecovervm:
          type: boolean
          description: True if the User can recover and expunge Instances, false otherwise
        allowuserexpungerecovervolume:
          type: boolean
          description: True if the User can recover and expunge volumes, false otherwise
        allowuserforcestopvm:
          type: boolean
          description: true if users are allowed to force stop a vm, false otherwise
        allowuserviewalldomainaccounts:
          type: boolean
          description: True if Users can see all Accounts within the same domain, false otherwise
        allowuserviewdestroyedvm:
          type: boolean
          description: True if the User is allowed to view the destroyed Instances, false otherwise
        apilimitinterval:
          type: integer
          format: int32
          description: Time interval (in seconds) to reset api count
        apilimitmax:
          type: integer
          format: int32
          description: Max allowed number of api requests within the specified interval
        cloudstackversion:
          type: string
          description: Version of the CloudStack
        customdiskofferingmaxsize:
          type: integer
          format: int64
          description: Maximum size that can be specified when create disk from disk offering with custom size
        customdiskofferingminsize:
          type: integer
          format: int64
          description: Minimum size that can be specified when create disk from disk offering with custom size
        customhypervisordisplayname:
          type: string
          description: Display name for custom hypervisor
        defaultuipagesize:
          type: integer
          format: int64
          description: Default page size in the UI for various views, value set in the configurations
        dynamicrolesenabled:
          type: boolean
          description: True if dynamic role-based api checker is enabled, false otherwise
        dynamicscalingenabled:
          type: boolean
          description: true if dynamically scaling for instances is enabled
        extensionspath:
          type: string
          description: The path of the extensions directory
        instanceleaseenabled:
          type: boolean
          description: true if instance lease feature is enabled
        instancesdisksstatsretentionenabled:
          type: boolean
          description: True if stats are retained for Instance disks otherwise false
        instancesdisksstatsretentiontime:
          type: integer
          format: int32
          description: The retention time for Instances disks stats
        instancesstatsretentiontime:
          type: integer
          format: int32
          description: The retention time for Instances stats
        instancesstatsuseronly:
          type: boolean
          description: True if stats are collected only for User Instances, false if System VM stats are also collected
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        kubernetesclusterexperimentalfeaturesenabled:
          type: boolean
          description: True if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise
        kubernetesserviceenabled:
          type: boolean
          description: True if Kubernetes Service plugin is enabled, false otherwise
        kvmsnapshotenabled:
          type: boolean
          description: True if Snapshot is supported for KVM host, false otherwise
        projectinviterequired:
          type: boolean
          description: If invitation confirmation is required when add Account to project
        regionsecondaryenabled:
          type: boolean
          description: True if region wide secondary is enabled, false otherwise
        securitygroupsenabled:
          type: boolean
          description: True if security groups support is enabled, false otherwise
        sharedfsvmmincpucount:
          type: integer
          format: int32
          description: the min CPU count for the service offering used by the shared filesystem instance
        sharedfsvmminramsize:
          type: integer
          format: int32
          description: the min Ram size for the service offering used by the shared filesystem instance
        snapshotshowchainsize:
          type: boolean
          description: True to show the parent and chain size (sum of physical size of snapshot and all its parents) for incremental snapshots
        supportELB:
          type: string
          description: True if region supports elastic Load balancer on basic zones
        userpublictemplateenabled:
          type: boolean
          description: True if user and domain admins can set Templates to be shared, false otherwise
        vpncustomergatewayparameters:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Excluded and obsolete VPN customer gateway cryptographic parameters
    Capacity:
      type: object
      properties:
        capacityallocated:
          type: integer
          format: int64
          description: The capacity currently in allocated
        capacitytotal:
          type: integer
          format: int64
          description: The total capacity available
        capacityused:
          type: integer
          format: int64
          description: The capacity currently in use
        clusterid:
          type: string
          description: The Cluster ID
        clustername:
          type: string
          description: The Cluster name
        name:
          type: string
          description: The capacity name
        percentused:
          type: string
          description: The percentage of capacity currently in use
        podid:
          type: string
          description: The Pod ID
        podname:
          type: string
          description: The Pod name
        tag:
          type: string
          description: The tag for the capacity type
        type:
          type: integer
          format: int32
          description: The capacity type
        zoneid:
          type: string
          description: The Zone ID
        zonename:
          type: string
          description: The Zone name
    Capacity2:
      type: object
      properties:
        capacityallocated:
          type: integer
          format: int64
          description: The capacity currently in allocated
        capacitytotal:
          type: integer
          format: int64
          description: The total capacity available
        capacityused:
          type: integer
          format: int64
          description: The capacity currently in use
        clusterid:
          type: string
          description: The Cluster ID
        clustername:
          type: string
          description: The Cluster name
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The capacity name
        percentused:
          type: string
          description: The percentage of capacity currently in use
        podid:
          type: string
          description: The Pod ID
        podname:
          type: string
          description: The Pod name
        tag:
          type: string
          description: The tag for the capacity type
        type:
          type: integer
          format: int32
          description: The capacity type
        zoneid:
          type: string
          description: The Zone ID
        zonename:
          type: string
          description: The Zone name
    ChangeOutOfBandManagementPasswordResult:
      type: object
      properties:
        action:
          type: string
          description: The out-of-band management action (if issued)
        address:
          type: string
          description: The out-of-band management interface address
        description:
          type: string
          description: The operation result description
        driver:
          type: string
          description: The out-of-band management driver for the host
        enabled:
          type: boolean
          description: True if out-of-band management is enabled for the host
        hostid:
          type: string
          description: The ID of the host
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        password:
          type: string
          description: The out-of-band management interface password
        port:
          type: string
          description: The out-of-band management interface port
        powerstate:
          type: string
          x-cloudstack-type: powerstate
          description: The out-of-band management interface powerState of the host
        status:
          type: boolean
          description: The operation result
        username:
          type: string
          description: The out-of-band management interface username
    CiscoAsa1000vResource:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    CiscoNexusVSM:
      type: object
      properties:
        ipaddress:
          type: string
          description: The management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        vsmconfigmode:
          type: string
          description: The mode of the VSM (standalone/HA)
        vsmconfigstate:
          type: string
          description: The Config State (Primary/Standby) of the VSM
        vsmctrlvlanid:
          type: integer
          format: int32
          description: Control VLAN ID of the VSM
        vsmdeviceid:
          type: string
          description: Device ID of the Cisco N1KV VSM device
        vsmdevicename:
          type: string
          description: Device name
        vsmdevicestate:
          type: string
          description: Device state
        vsmdomainid:
          type: string
          description: The VSM is a switch supervisor. This is the VSM's switch domain ID
        vsmmgmtvlanid:
          type: string
          description: Management VLAN ID of the VSM
        vsmpktvlanid:
          type: integer
          format: int32
          description: Packet VLAN ID of the VSM
        vsmstoragevlanid:
          type: integer
          format: int32
          description: Storage VLAN ID of the VSM
    CloudIdentifier:
      type: object
      properties:
        cloudidentifier:
          type: string
          description: The cloud identifier
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        signature:
          type: string
          description: The signed response for the cloud identifier
        userid:
          type: string
          description: The User ID for the cloud identifier
    CloudianIsEnabled:
      type: object
      properties:
        enabled:
          type: boolean
          description: The Cloudian connector enabled state
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        url:
          type: string
          description: The Cloudian Management Console base URL
    Cluster:
      type: object
      properties:
        allocationstate:
          type: string
          description: The allocation state of the cluster
        arch:
          type: string
          description: CPU Arch of the hosts in the cluster
        capacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          x-cloudstack-type: list
          description: The capacity of the Cluster
        clustertype:
          type: string
          description: The type of the cluster
        cpuovercommitratio:
          type: string
          description: The CPU overcommit ratio of the cluster
        extensionid:
          type: string
          description: The ID of extension for this cluster
        extensionname:
          type: string
          description: The name of extension for this cluster
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hypervisortype:
          type: string
          description: The hypervisor type of the cluster
        id:
          type: string
          description: The cluster ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        managedstate:
          type: string
          description: Whether this cluster is managed by Cloudstack
        memoryovercommitratio:
          type: string
          description: The memory overcommit ratio of the cluster
        name:
          type: string
          description: The cluster name
        ovm3vip:
          type: string
          description: Ovm3 VIP to use for pooling and/or clustering
        podid:
          type: string
          description: The Pod ID of the cluster
        podname:
          type: string
          description: The Pod name of the cluster
        podstorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the pod
        resourcedetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Meta data associated with the zone (key/value pairs)
        storageaccessgroups:
          type: string
          description: comma-separated list of storage access groups for the host
        zoneid:
          type: string
          description: The Zone ID of the cluster
        zonename:
          type: string
          description: The Zone name of the cluster
        zonestorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the zone
    ClusterDrsPlan:
      type: object
      properties:
        clusterid:
          type: string
          description: Id of the cluster
        eventid:
          type: string
          description: Start event Id of the DRS Plan
        id:
          type: string
          description: unique ID of the drs plan for cluster
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        migrations:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List of migrations
        status:
          type: string
          x-cloudstack-type: status
          description: Status of DRS Plan
        type:
          type: string
          x-cloudstack-type: type
          description: Type of DRS Plan (Automated or Manual))
    ClustersMetric:
      type: object
      properties:
        allocationstate:
          type: string
          description: The allocation state of the cluster
        arch:
          type: string
          description: CPU Arch of the hosts in the cluster
        capacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          x-cloudstack-type: list
          description: The capacity of the Cluster
        clustertype:
          type: string
          description: The type of the cluster
        cpuallocated:
          type: string
          description: The total cpu allocated in Ghz
        cpuallocateddisablethreshold:
          type: boolean
          description: CPU allocated disable threshold exceeded
        cpuallocatedthreshold:
          type: boolean
          description: CPU allocated notification threshold exceeded
        cpudisablethreshold:
          type: boolean
          description: CPU usage disable threshold exceeded
        cpumaxdeviation:
          type: string
          description: The maximum cpu deviation
        cpuovercommitratio:
          type: string
          description: The CPU overcommit ratio of the cluster
        cputhreshold:
          type: boolean
          description: CPU usage notification threshold exceeded
        cputotal:
          type: string
          description: The total cpu capacity in Ghz
        cpuused:
          type: string
          description: The total cpu used in Ghz
        drsimbalance:
          type: string
          description: DRS imbalance for the cluster
        extensionid:
          type: string
          description: The ID of extension for this cluster
        extensionname:
          type: string
          description: The name of extension for this cluster
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hosts:
          type: string
          description: Running / total hosts in the cluster
        hypervisortype:
          type: string
          description: The hypervisor type of the cluster
        id:
          type: string
          description: The cluster ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        managedstate:
          type: string
          description: Whether this cluster is managed by Cloudstack
        memoryallocated:
          type: string
          description: The total cpu allocated in GiB
        memoryallocateddisablethreshold:
          type: boolean
          description: Memory allocated disable threshold exceeded
        memoryallocatedthreshold:
          type: boolean
          description: Memory allocated notification threshold exceeded
        memorydisablethreshold:
          type: boolean
          description: Memory usage disable threshold exceeded
        memorymaxdeviation:
          type: string
          description: The maximum memory deviation
        memoryovercommitratio:
          type: string
          description: The memory overcommit ratio of the cluster
        memorythreshold:
          type: boolean
          description: Memory usage notification threshold exceeded
        memorytotal:
          type: string
          description: The total cpu capacity in GiB
        memoryused:
          type: string
          description: The total cpu used in GiB
        name:
          type: string
          description: The cluster name
        ovm3vip:
          type: string
          description: Ovm3 VIP to use for pooling and/or clustering
        podid:
          type: string
          description: The Pod ID of the cluster
        podname:
          type: string
          description: The Pod name of the cluster
        podstorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the pod
        resourcedetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Meta data associated with the zone (key/value pairs)
        state:
          type: string
          description: State of the cluster
        storageaccessgroups:
          type: string
          description: comma-separated list of storage access groups for the host
        zoneid:
          type: string
          description: The Zone ID of the cluster
        zonename:
          type: string
          description: The Zone name of the cluster
        zonestorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the zone
    Condition:
      type: object
      properties:
        account:
          type: string
          description: The owner of the Condition.
        counter:
          type: object
          x-cloudstack-type: counterresponse
          description: Details of the Counter.
        counterid:
          type: string
          description: The ID of the Counter.
        countername:
          type: string
          description: The Name of the Counter.
        domain:
          type: string
          description: The domain name of the owner.
        domainid:
          type: string
          description: The domain ID of the Condition owner
        domainpath:
          type: string
          description: path of the domain to which the Condition owner belongs
        id:
          type: string
          description: The ID of the Condition
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        project:
          type: string
          description: The project name of the Condition
        projectid:
          type: string
          description: The project ID of the Condition.
        relationaloperator:
          type: string
          description: Relational Operator to be used with threshold.
        threshold:
          type: integer
          format: int64
          description: Threshold Value for the counter.
        zoneid:
          type: string
          description: Zone ID of counter
    Configuration:
      type: object
      properties:
        category:
          type: string
          description: The category of the configuration
        component:
          type: string
          description: The component of the configuration
        defaultvalue:
          type: string
          description: The default value of the configuration
        description:
          type: string
          description: The description of the configuration
        displaytext:
          type: string
          description: The display text of the configuration
        group:
          type: string
          description: The group of the configuration
        id:
          type: integer
          format: int64
          description: The value of the configuration
        isdynamic:
          type: boolean
          description: True if the configuration is dynamic
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the configuration
        options:
          type: string
          description: The possible options of the configuration value
        parent:
          type: string
          description: The name of the parent configuration
        scope:
          type: string
          description: Scope (zone/cluster/pool/account) of the parameter that needs to be updated
        subgroup:
          type: string
          description: The subgroup of the configuration
        type:
          type: string
          description: The type of the configuration value
        value:
          type: string
          description: The value of the configuration
    ConfigurationGroup:
      type: object
      properties:
        description:
          type: string
          description: The description of the configuration group
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the configuration group
        precedence:
          type: integer
          format: int64
          description: The precedence of the configuration group
        subgroup:
          type: array
          items:
            $ref: '#/components/schemas/Subgroup'
          x-cloudstack-type: list
          description: The subgroups of the configuration group
    ConsoleEndpoint:
      type: object
      properties:
        details:
          type: string
          description: Details in case of an error
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        success:
          type: boolean
          description: True if the console endpoint is generated properly
        url:
          type: string
          description: The console url
        websocket:
          type: object
          x-cloudstack-type: consoleendpointwebsocketresponse
          description: The console websocket options
    ConsoleSession:
      type: object
      properties:
        account:
          type: string
          description: Account that created the console endpoint.
        accountid:
          type: string
          description: ID of the account that created the console endpoint.
        acquired:
          type: string
          x-cloudstack-type: date
          description: Date when the console session was acquired. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        clientaddress:
          type: string
          description: IP address of the client that created the console session.
        consoleendpointcreatoraddress:
          type: string
          description: IP address of the creator of the console endpoint.
        created:
          type: string
          x-cloudstack-type: date
          description: Date when the console session's endpoint was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: Domain of the account that created the console endpoint.
        domainid:
          type: string
          description: Domain ID of the account that created the console endpoint.
        domainpath:
          type: string
          description: Domain path of the account that created the console endpoint.
        hostid:
          type: string
          description: ID of the host.
        hostname:
          type: string
          description: Name of the host.
        id:
          type: string
          description: ID of the console session.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        removed:
          type: string
          x-cloudstack-type: date
          description: Date when the console session was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        user:
          type: string
          description: User that created the console endpoint.
        userid:
          type: string
          description: ID of the user that created the console endpoint.
        virtualmachineid:
          type: string
          description: ID of the virtual machine.
        virtualmachinename:
          type: string
          description: Name of the virtual machine.
    Counter:
      type: object
      properties:
        id:
          type: string
          description: The ID of the Counter
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the counter.
        provider:
          type: string
          description: Provider of the counter.
        source:
          type: string
          description: Source of the counter.
        value:
          type: string
          description: Value in case of snmp or other specific counters.
        zoneid:
          type: string
          description: Zone ID of counter
    CreateGuestNetworkIpv6PrefixResult:
      type: object
      properties:
        availablesubnets:
          type: integer
          format: int32
          description: Count of the available IPv6 subnets for the prefix.
        created:
          type: string
          x-cloudstack-type: date
          description: Date when this IPv6 prefix was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        id:
          type: string
          description: ID of the guest IPv6 prefix
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        prefix:
          type: string
          description: Guest IPv6 prefix
        totalsubnets:
          type: integer
          format: int32
          description: Count of the total IPv6 subnets for the prefix.
        usedsubnets:
          type: integer
          format: int32
          description: Count of the used IPv6 subnets for the prefix.
        zoneid:
          type: string
          description: ID of zone to which the IPv6 prefix belongs to.
    CreateIpv4SubnetForGuestNetworkResult:
      type: object
      properties:
        allocated:
          type: string
          x-cloudstack-type: date
          description: date when this IPv4 subnet was allocated. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        created:
          type: string
          x-cloudstack-type: date
          description: date when this IPv4 subnet was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        id:
          type: string
          description: id of the IPv4 subnet for guest network
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        networkid:
          type: string
          description: id of network which the IPv4 subnet is associated with.
        networkname:
          type: string
          description: name of network which the IPv4 subnet is associated with.
        parentid:
          type: string
          description: id of the data center IPv4 subnet
        parentsubnet:
          type: string
          description: subnet of the data center IPv4 subnet
        removed:
          type: string
          x-cloudstack-type: date
          description: date when this IPv4 subnet was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        state:
          type: string
          description: state of subnet of the IPv4 network
        subnet:
          type: string
          description: subnet of the IPv4 network
        vpcid:
          type: string
          description: Id of the VPC which the IPv4 subnet is associated with.
        vpcname:
          type: string
          description: Name of the VPC which the IPv4 subnet is associated with.
        zoneid:
          type: string
          description: id of zone to which the IPv4 subnet belongs to.
        zonename:
          type: string
          description: id of zone to which the IPv4 subnet belongs to.
    CustomAction:
      type: object
      properties:
        allowedroletypes:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List of role types allowed for the custom action
        created:
          type: string
          x-cloudstack-type: date
          description: Creation timestamp of the custom action. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: Description of the custom action
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Details of the custom action
        enabled:
          type: boolean
          description: Whether the custom action is enabled or not
        errormessage:
          type: string
          description: Message that will be used on failure during execution of the action
        extensionid:
          type: string
          description: ID of the extension that this custom action belongs to
        extensionname:
          type: string
          description: Name of the extension that this custom action belongs to
        id:
          type: string
          description: ID of the custom action
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the custom action
        parameters:
          type: array
          items:
            $ref: '#/components/schemas/Parameters'
          x-cloudstack-type: list
          description: List of the parameters for the action
        resourcetype:
          type: string
          description: Resource type for which the action is available
        successmessage:
          type: string
          description: Message that will be used on successful execution of the action
        timeout:
          type: integer
          format: int32
          description: Specifies the timeout in seconds to wait for the action to complete before failing
    CustomAction2:
      type: object
      properties:
        id:
          type: string
          description: ID of the action
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the action
        result:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Result of the action execution
        success:
          type: boolean
          description: Whether custom action succeed or not
    CustomCertificate:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        message:
          type: string
          description: Message of the certificate upload operation
    DbMetric:
      type: object
      properties:
        collectiontime:
          type: string
          x-cloudstack-type: date
          description: The time these statistics were collected. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        connections:
          type: integer
          format: int32
          description: The number of connections to the DB
        dbloadaverages:
          type: array
          items:
            type: number
            format: double
          description: The last measured load averages on the DB
        hostname:
          type: string
          description: The name of the active usage server
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        queries:
          type: integer
          format: int64
          description: The number of queries performed on the DB
        replicas:
          type: array
          items:
            type: string
          description: The state of the usage server
        tlsversions:
          type: string
          description: The TLS versions currently in use (accepted) by the DB
        uptime:
          type: integer
          format: int64
          description: The uptime of the DB in seconds
        version:
          type: string
          description: The version of the currently running DB
        versioncomment:
          type: string
          description: The version of the currently running DB
    DedicateClusterResult:
      type: object
      properties:
        accountid:
          type: string
          description: The Account ID of the cluster
        affinitygroupid:
          type: string
          description: The Dedication Affinity Group ID of the cluster
        clusterid:
          type: string
          description: The ID of the cluster
        clustername:
          type: string
          description: The name of the cluster
        domainid:
          type: string
          description: The domain ID of the cluster
        id:
          type: string
          description: The ID of the dedicated resource
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    DedicateGuestVlanRangeResult:
      type: object
      properties:
        account:
          type: string
          description: The Account of the guest VLAN range
        domain:
          type: string
          description: The domain name of the guest VLAN range
        domainid:
          type: string
          description: The domain ID of the guest VLAN range
        domainpath:
          type: string
          description: path of the domain to which the guest VLAN range belongs
        guestvlanrange:
          type: string
          description: The guest VLAN range
        id:
          type: string
          description: The ID of the guest VLAN range
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        physicalnetworkid:
          type: integer
          format: int64
          description: The physical Network of the guest VLAN range
        project:
          type: string
          description: The project name of the guest VLAN range
        projectid:
          type: string
          description: The project id of the guest VLAN range
        zoneid:
          type: integer
          format: int64
          description: The zone of the guest VLAN range
    DedicateHostResult:
      type: object
      properties:
        accountid:
          type: string
          description: The Account ID of the host
        affinitygroupid:
          type: string
          description: The Dedication Affinity Group ID of the host
        domainid:
          type: string
          description: The domain ID of the host
        hostid:
          type: string
          description: The ID of the host
        hostname:
          type: string
          description: The name of the host
        id:
          type: string
          description: The ID of the dedicated resource
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    DedicatePodResult:
      type: object
      properties:
        accountid:
          type: string
          description: The Account Id to which the Pod is dedicated
        affinitygroupid:
          type: string
          description: The Dedication Affinity Group ID of the pod
        domainid:
          type: string
          description: The domain ID to which the Pod is dedicated
        id:
          type: string
          description: The ID of the dedicated resource
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        podid:
          type: string
          description: The ID of the Pod
        podname:
          type: string
          description: The Name of the Pod
    DedicateZoneResult:
      type: object
      properties:
        accountid:
          type: string
          description: The Account ID to which the Zone is dedicated
        affinitygroupid:
          type: string
          description: The Dedication Affinity Group ID of the zone
        domainid:
          type: string
          description: The domain ID to which the Zone is dedicated
        id:
          type: string
          description: The ID of the dedicated resource
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        zoneid:
          type: string
          description: The ID of the Zone
        zonename:
          type: string
          description: The Name of the Zone
    DetailOption:
      type: object
      properties:
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Map of all possible details and their possible list of values
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    Diagnostic:
      type: object
      properties:
        exitcode:
          type: string
          description: The command execution return code
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        stderr:
          type: string
          description: The standard error output from the command execution
        stdout:
          type: string
          description: The standard output from the command execution
    DiagnosticsData:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        url:
          type: string
          description: Storage URL to download retrieve diagnostics data files
    Disk:
      type: object
      properties:
        capacity:
          type: integer
          format: int64
          description: The capacity of the disk in bytes
        controller:
          type: string
          description: The controller of the disk
        controllerunit:
          type: integer
          format: int32
          description: The controller unit of the disk
        datastorehost:
          type: string
          description: The controller of the disk
        datastorename:
          type: string
          description: The controller of the disk
        datastorepath:
          type: string
          description: The controller of the disk
        datastoretype:
          type: string
          description: The controller of the disk
        id:
          type: string
          description: The ID of the disk
        imagepath:
          type: string
          description: The file path of the disk image
        label:
          type: string
          description: The label of the disk
        position:
          type: integer
          format: int32
          description: The position of the disk
    DiskOffering:
      type: object
      properties:
        cacheMode:
          type: string
          description: The cache mode to use for this disk offering. none, writeback or writethrough
        created:
          type: string
          x-cloudstack-type: date
          description: The date this disk offering was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Additional key/value details tied with this disk offering
        diskBytesReadRate:
          type: integer
          format: int64
          description: Bytes read rate of the disk offering
        diskBytesReadRateMax:
          type: integer
          format: int64
          description: Burst bytes read rate of the disk offering
        diskBytesReadRateMaxLength:
          type: integer
          format: int64
          description: Length (in seconds) of the burst
        diskBytesWriteRate:
          type: integer
          format: int64
          description: Bytes write rate of the disk offering
        diskBytesWriteRateMax:
          type: integer
          format: int64
          description: Burst bytes write rate of the disk offering
        diskBytesWriteRateMaxLength:
          type: integer
          format: int64
          description: Length (in seconds) of the burst
        diskIopsReadRate:
          type: integer
          format: int64
          description: I/O requests read rate of the disk offering
        diskIopsReadRateMax:
          type: integer
          format: int64
          description: Burst io requests read rate of the disk offering
        diskIopsReadRateMaxLength:
          type: integer
          format: int64
          description: Length (in second) of the burst
        diskIopsWriteRate:
          type: integer
          format: int64
          description: I/O requests write rate of the disk offering
        diskIopsWriteRateMax:
          type: integer
          format: int64
          description: Burst io requests write rate of the disk offering
        diskIopsWriteRateMaxLength:
          type: integer
          format: int64
          description: Length (in seconds) of the burst
        disksize:
          type: integer
          format: int64
          description: The size of the disk offering in GB
        disksizestrictness:
          type: boolean
          description: To allow or disallow the resize operation on the disks created from this disk offering, if the flag is true then resize is not allowed
        displayoffering:
          type: boolean
          description: Whether to display the offering to the end user or not.
        displaytext:
          type: string
          description: An alternate display text of the disk offering.
        domain:
          type: string
          description: The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        domainid:
          type: string
          description: The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        encrypt:
          type: boolean
          description: Whether disks using this offering will be encrypted on primary storage
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hypervisorsnapshotreserve:
          type: integer
          format: int32
          description: Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
        id:
          type: string
          description: Unique ID of the disk offering
        iscustomized:
          type: boolean
          description: True if disk offering uses custom size, false otherwise
        iscustomizediops:
          type: boolean
          description: True if disk offering uses custom IOPS, false otherwise
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        maxiops:
          type: integer
          format: int64
          description: The max IOPS of the disk offering
        miniops:
          type: integer
          format: int64
          description: The min IOPS of the disk offering
        name:
          type: string
          description: The name of the disk offering
        provisioningtype:
          type: string
          description: Provisioning type used to create volumes. Valid values are thin, sparse, fat.
        state:
          type: string
          description: state of the disk offering
        storagetype:
          type: string
          description: The storage type for this disk offering
        suitableforvirtualmachine:
          type: boolean
          description: Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false
        tags:
          type: string
          description: The tags for the disk offering
        vspherestoragepolicy:
          type: string
          description: The vsphere storage policy tagged to the disk offering in case of VMware
        zone:
          type: string
          description: The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        zoneid:
          type: string
          description: The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
    DnsRecord:
      type: object
      properties:
        contents:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The contents of the record (IP address or target)
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The record name (e.g., www.example.com.)
        ttl:
          type: integer
          format: int32
          description: Time to live (TTL) in seconds
        type:
          type: string
          x-cloudstack-type: recordtype
          description: The record type (e.g., A, CNAME, TXT)
    DnsServer:
      type: object
      properties:
        account:
          type: string
          description: the account associated with the DNS server
        domain:
          type: string
          description: the name of the domain associated with the DNS server
        domainid:
          type: string
          description: the ID of the domain associated with the DNS server
        id:
          type: string
          description: ID of the DNS server
        ispublic:
          type: boolean
          description: Is the DNS server publicly available
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the DNS server
        nameservers:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Name servers entries associated to DNS server
        port:
          type: integer
          format: int32
          description: The port of the DNS server
        provider:
          type: string
          description: The provider type of the DNS server
        publicdomainsuffix:
          type: string
          description: The public domain suffix for the DNS server
        state:
          type: string
          description: The state of the account
        url:
          type: string
          description: URL of the DNS server API
    DnsZone:
      type: object
      properties:
        account:
          type: string
          description: the account associated with the DNS zone
        description:
          type: string
          description: Description for the DNS zone
        dnsserveraccount:
          type: string
          description: the account name of the DNS server owner
        dnsserverid:
          type: string
          description: ID of the DNS server this zone belongs to
        dnsservername:
          type: string
          description: the name of the DNS server hosting this zone
        domain:
          type: string
          description: the name of the domain associated with the DNS zone
        domainid:
          type: string
          description: the ID of the domain associated with the DNS server
        id:
          type: string
          description: ID of the DNS zone
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the DNS zone
        networkid:
          type: string
          description: ID of the network this zone is associated with
        networkname:
          type: string
          description: Name of the network this zone is associated with
        state:
          type: string
          x-cloudstack-type: state
          description: The state of the zone (Active/Inactive)
        type:
          type: string
          x-cloudstack-type: zonetype
          description: The type of the zone (Public/Private)
    DnsZoneToNetwork:
      type: object
      properties:
        dnszoneid:
          type: string
          description: The ID of the DNS zone
        id:
          type: string
          description: The ID of the mapping
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        networkid:
          type: string
          description: The ID of the Network
        subdomain:
          type: string
          description: The sub domain name of the auto-registered DNS record
    Domain:
      type: object
      properties:
        backupavailable:
          type: string
          description: the total number of backups available to this domain
        backuplimit:
          type: string
          description: the total number of backups which can be stored by this domain
        backupstorageavailable:
          type: string
          description: the total backup storage space (in GiB) available to the domain
        backupstoragelimit:
          type: string
          description: the total backup storage space (in GiB) the domain can own
        backupstoragetotal:
          type: integer
          format: int64
          description: the total backup storage space (in GiB) owned by the domain
        backuptotal:
          type: integer
          format: int64
          description: the total number of backups stored by this domain
        bucketavailable:
          type: string
          description: the total number of buckets available to this domain
        bucketlimit:
          type: string
          description: the total number of buckets which can be stored by this domain
        buckettotal:
          type: integer
          format: int64
          description: the total number of buckets stored by this domain
        cpuavailable:
          type: string
          description: The total number of CPU cores available to be created for this domain
        cpulimit:
          type: string
          description: The total number of CPU cores the domain can own
        cputotal:
          type: integer
          format: int64
          description: The total number of CPU cores owned by domain
        created:
          type: string
          x-cloudstack-type: date
          description: The date when this domain was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domaindetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Details for the domain
        gpuavailable:
          type: string
          description: the total number of gpus available to be created for this domain
        gpulimit:
          type: string
          description: the total number of gpus the domain can own
        gputotal:
          type: integer
          format: int64
          description: the total number of gpus owned by domain
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        haschild:
          type: boolean
          description: Whether the domain has one or more sub-domains
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The ID of the domain
        ipavailable:
          type: string
          description: The total number of public IP addresses available for this domain to acquire
        iplimit:
          type: string
          description: The total number of public IP addresses this domain can acquire
        iptotal:
          type: integer
          format: int64
          description: The total number of public IP addresses allocated for this domain
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        level:
          type: integer
          format: int32
          description: The level of the domain
        memoryavailable:
          type: string
          description: The total memory (in MB) available to be created for this domain
        memorylimit:
          type: string
          description: The total memory (in MB) the domain can own
        memorytotal:
          type: integer
          format: int64
          description: The total memory (in MB) owned by domain
        name:
          type: string
          description: The name of the domain
        networkavailable:
          type: string
          description: The total number of Networks available to be created for this domain
        networkdomain:
          type: string
          description: The Network domain
        networklimit:
          type: string
          description: The total number of Networks the domain can own
        networktotal:
          type: integer
          format: int64
          description: The total number of Networks owned by domain
        objectstorageavailable:
          type: string
          description: the total object storage space (in GiB) available to the domain
        objectstoragelimit:
          type: string
          description: the total object storage space (in GiB) the domain can own
        objectstoragetotal:
          type: integer
          format: int64
          description: the total object storage space (in GiB) owned by the domain
        parentdomainid:
          type: string
          description: The domain ID of the parent domain
        parentdomainname:
          type: string
          description: The domain name of the parent domain
        path:
          type: string
          description: The path of the domain
        primarystorageavailable:
          type: string
          description: The total primary storage space (in GiB) available to be used for this domain
        primarystoragelimit:
          type: string
          description: The total primary storage space (in GiB) the domain can own
        primarystoragetotal:
          type: integer
          format: int64
          description: The total primary storage space (in GiB) owned by domain
        projectavailable:
          type: string
          description: The total number of projects available for administration by this domain
        projectlimit:
          type: string
          description: The total number of projects the domain can own
        projecttotal:
          type: integer
          format: int64
          description: The total number of projects being administrated by this domain
        secondarystorageavailable:
          type: string
          description: The total secondary storage space (in GiB) available to be used for this domain
        secondarystoragelimit:
          type: string
          description: The total secondary storage space (in GiB) the domain can own
        secondarystoragetotal:
          type: number
          format: float
          description: The total secondary storage space (in GiB) owned by domain
        snapshotavailable:
          type: string
          description: The total number of Snapshots available for this domain
        snapshotlimit:
          type: string
          description: The total number of Snapshots which can be stored by this domain
        snapshottotal:
          type: integer
          format: int64
          description: The total number of Snapshots stored by this domain
        state:
          type: string
          description: The state of the domain
        taggedresources:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The tagged resource limit and count for the domain
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        templateavailable:
          type: string
          description: The total number of Templates available to be created by this domain
        templatelimit:
          type: string
          description: The total number of Templates which can be created by this domain
        templatetotal:
          type: integer
          format: int64
          description: The total number of Templates which have been created by this domain
        vmavailable:
          type: string
          description: The total number of Instances available for this domain to acquire
        vmlimit:
          type: string
          description: The total number of Instances that can be deployed by this domain
        vmtotal:
          type: integer
          format: int64
          description: The total number of Instances deployed by this domain
        volumeavailable:
          type: string
          description: The total volume available for this domain
        volumelimit:
          type: string
          description: The total volume which can be used by this domain
        volumetotal:
          type: integer
          format: int64
          description: The total volume being used by this domain
        vpcavailable:
          type: string
          description: The total number of VPCs available to be created for this domain
        vpclimit:
          type: string
          description: The total number of VPCs the domain can own
        vpctotal:
          type: integer
          format: int64
          description: The total number of VPCs owned by domain
    DownloadImageStoreObjectResult:
      type: object
      properties:
        accountid:
          type: string
          description: The Account ID to which the extracted object belongs
        created:
          type: string
          x-cloudstack-type: date
          description: The time and date the object was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        extractId:
          type: string
          description: The upload ID of extracted object
        extractMode:
          type: string
          description: The mode of extraction - upload or download
        id:
          type: string
          description: The ID of extracted object
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the extracted object
        resultstring:
          type: string
        state:
          type: string
          description: The state of the extracted object
        status:
          type: string
          description: The status of the extraction
        storagetype:
          type: string
          description: Type of the storage
        uploadpercentage:
          type: integer
          format: int32
          description: The percentage of the entity uploaded to the specified location
        url:
          type: string
          description: If mode = upload then URL of the uploaded entity. if mode = download the URL from which the entity can be downloaded
        zoneid:
          type: string
          description: Zone ID the object was extracted from
        zonename:
          type: string
          description: Zone name the object was extracted from
    EgressFirewallRule:
      type: object
      properties:
        cidrlist:
          type: string
          description: The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
        destcidrlist:
          type: string
          description: The CIDR list to forward traffic to. Multiple entries are separated by a single comma character (,).
        endport:
          type: integer
          format: int32
          description: The ending port of firewall rule's port range
        fordisplay:
          type: boolean
          description: Is rule for display to the regular user
        icmpcode:
          type: integer
          format: int32
          description: Error code for this ICMP message
        icmptype:
          type: integer
          format: int32
          description: Type of the ICMP message being sent
        id:
          type: string
          description: The ID of the firewall rule
        ipaddress:
          type: string
          description: The public IP address for the firewall rule
        ipaddressid:
          type: string
          description: The public IP address ID for the firewall rule
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        networkid:
          type: string
          description: The Network ID of the firewall rule
        protocol:
          type: string
          description: The protocol of the firewall rule
        startport:
          type: integer
          format: int32
          description: The starting port of firewall rule's port range
        state:
          type: string
          description: The state of the rule
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with the rule
        traffictype:
          type: string
          description: The traffic type for the firewall rule
        vpcid:
          type: string
          description: The VPC ID of the firewall rule
    ElastistorPool:
      type: object
      properties:
        controllerid:
          type: string
          description: Controller of the pool
        gateway:
          type: string
          description: Default gateway of the pool
        id:
          type: string
          description: The ID of the storage pool
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        maxiops:
          type: integer
          format: int64
          description: Available IOPS of the pool
        name:
          type: string
          description: The name of the storage pool
        size:
          type: integer
          format: int64
          description: The current available space of the pool
        state:
          type: string
          description: The state of the storage pool
    Event:
      type: object
      properties:
        account:
          type: string
          description: The Account name for the Account that owns the object being acted on in the event (e.g. the owner of the Instance, IP address, or security group)
        archived:
          type: boolean
          description: Whether the event has been archived or not
        created:
          type: string
          x-cloudstack-type: date
          description: The date the event was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: A brief description of the event
        domain:
          type: string
          description: The name of the Account's domain
        domainid:
          type: string
          description: The ID of the Account's domain
        domainpath:
          type: string
          description: path of the Domain the account's domain belongs to
        id:
          type: string
          description: The ID of the event
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        level:
          type: string
          description: The event level (INFO, WARN, ERROR)
        parentid:
          type: string
          description: Whether the event is parented
        project:
          type: string
          description: The project name of the address
        projectid:
          type: string
          description: The project ID of the IP address
        resourceid:
          type: string
          description: The ID of the resource
        resourcename:
          type: string
          description: The name of the resource
        resourcetype:
          type: string
          description: The type of the resource
        state:
          type: string
          x-cloudstack-type: state
          description: The state of the event
        type:
          type: string
          description: The type of the event (see event types)
        username:
          type: string
          description: The name of the User who performed the action (can be different from the Account if an admin is performing an action for a User, e.g. starting/stopping a User's Instance)
    ExecuteWebhookDelivery:
      type: object
      properties:
        enddate:
          type: string
          x-cloudstack-type: date
          description: The end time of the Webhook delivery. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        eventid:
          type: string
          description: The ID of the event
        eventtype:
          type: string
          description: The type of the event
        headers:
          type: string
          description: The headers of the webhook delivery
        id:
          type: string
          description: The ID of the Webhook delivery
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        managementserverid:
          type: string
          description: The ID of the management server which executed delivery
        managementservername:
          type: string
          description: The name of the management server which executed delivery
        payload:
          type: string
          description: The payload of the webhook delivery
        response:
          type: string
          description: The response of the webhook delivery
        startdate:
          type: string
          x-cloudstack-type: date
          description: The start time of the Webhook delivery. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        success:
          type: boolean
          description: Whether Webhook delivery succeeded or not
        webhookid:
          type: string
          description: The ID of the Webhook
        webhookname:
          type: string
          description: The name of the Webhook
    Extension:
      type: object
      properties:
        created:
          type: string
          x-cloudstack-type: date
          description: Creation timestamp of the extension. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: Description of the extension
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: The details of the extension
        id:
          type: string
          description: ID of the extension
        isuserdefined:
          type: boolean
          description: True if the extension is added by admin
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the extension
        path:
          type: string
          description: The path of the entry point fo the extension
        pathready:
          type: boolean
          description: True if the extension path is in ready state across management servers
        removed:
          type: string
          x-cloudstack-type: date
          description: Removal timestamp of the extension, if applicable. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        reservedresourcedetails:
          type: string
          description: Resource detail names as comma separated string that should be reserved and not visible to end users
        resources:
          type: array
          items:
            $ref: '#/components/schemas/Resources'
          x-cloudstack-type: list
          description: List of resources to which extension is registered to
        state:
          type: string
          description: The state of the extension
        type:
          type: string
          description: Type of the extension
    GetUploadParamsForIsoResult:
      type: object
      properties:
        expires:
          type: string
          description: The timestamp after which the signature expires
        id:
          type: string
          format: uuid
          description: The Template/volume ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        metadata:
          type: string
          description: Encrypted data to be sent in the POST request.
        postURL:
          type: string
          x-cloudstack-type: url
          description: POST url to upload the file to
        signature:
          type: string
          description: Signature to be sent in the POST request.
    GetVolumeSnapshotDetailsResult:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        volumeiScsiName:
          type: string
          description: Volume iSCSI Name
    GlobalLoadBalancerRule:
      type: object
      properties:
        account:
          type: string
          description: The Account of the Load balancer rule
        description:
          type: string
          description: The description of the global Load balancer rule
        domain:
          type: string
          description: The domain of the Load balancer rule
        domainid:
          type: string
          description: The domain ID of the Load balancer rule
        domainpath:
          type: string
          description: path of the domain to which the load balancer rule belongs
        gslbdomainname:
          type: string
          description: DNS domain name given for the global Load balancer
        gslblbmethod:
          type: string
          description: Load balancing method used for the global Load balancer
        gslbservicetype:
          type: string
          description: GSLB service type
        gslbstickysessionmethodname:
          type: string
          description: Session persistence method used for the global Load balancer
        id:
          type: string
          description: Global Load balancer rule ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        loadbalancerrule:
          type: array
          items:
            $ref: '#/components/schemas/Loadbalancerrule'
          x-cloudstack-type: list
          description: List of Load balancer rules that are part of GSLB rule
        name:
          type: string
          description: Name of the global Load balancer rule
        project:
          type: string
          description: The project name of the Load balancer
        projectid:
          type: string
          description: The project ID of the Load balancer
        regionid:
          type: integer
          format: int32
          description: Region ID in which global Load balancer is created
    GpuCard:
      type: object
      properties:
        deviceid:
          type: string
          description: the device ID of the GPU card
        devicename:
          type: string
          description: the device name of the GPU card
        id:
          type: string
          description: the ID of the GPU card
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: the display name of the GPU card
        vendorid:
          type: string
          description: the vendor ID of the GPU card
        vendorname:
          type: string
          description: the vendor name of the GPU card
    GpuDevice:
      type: object
      properties:
        busaddress:
          type: string
          description: bus address of the GPU device or MDEV UUID for vGPU devices
        gpucardid:
          type: string
          description: the GPU card ID associated with this GPU device
        gpucardname:
          type: string
          description: the GPU card name associated with this GPU device
        gpudevicetype:
          type: string
          x-cloudstack-type: devicetype
          description: bus address of the GPU device
        hostid:
          type: string
          description: the host ID where the GPU device is attached
        hostname:
          type: string
          description: the host name where the GPU device is attached
        id:
          type: string
          description: the ID of the GPU device
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        managedstate:
          type: string
          x-cloudstack-type: managedstate
          description: the managed state of the GPU device (Enabled/Disabled)
        numanode:
          type: string
          description: the NUMA node where the GPU device is located
        parentgpudeviceid:
          type: string
          description: the ID of the parent GPU device, if this is a vGPU
        state:
          type: string
          x-cloudstack-type: state
          description: the vGPU profile name assigned to this GPU device
        vgpuprofileid:
          type: string
          description: the vGPU profile ID assigned to this GPU device
        vgpuprofilename:
          type: string
          description: the vGPU profile name assigned to this GPU device
        virtualmachineid:
          type: string
          description: the vGPU profile ID assigned to this GPU device
        virtualmachinename:
          type: string
          description: the vGPU profile name assigned to this GPU device
        vmstate:
          type: string
          x-cloudstack-type: state
          description: the state of the virtual machine to which this GPU device is allocated
    Gpugroup:
      type: object
      properties:
        gpugroupname:
          type: string
          description: GPU cards present in the host
        vgpu:
          type: array
          items:
            $ref: '#/components/schemas/Vgpu'
          x-cloudstack-type: list
          description: The list of enabled vGPUs
    GuestO:
      type: object
      properties:
        description:
          type: string
          description: The name/description of the OS type
        fordisplay:
          type: boolean
          description: Is the guest OS visible for the users
        id:
          type: string
          description: The ID of the OS type
        isuserdefined:
          type: boolean
          description: Is the guest OS user defined
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the OS type
        oscategoryid:
          type: string
          description: The ID of the OS category
        oscategoryname:
          type: string
          description: The name of the OS category
    GuestOsMapping:
      type: object
      properties:
        hypervisor:
          type: string
          description: The hypervisor
        hypervisorversion:
          type: string
          description: Version of the hypervisor for mapping
        id:
          type: string
          description: The ID of the Guest OS mapping
        isuserdefined:
          type: string
          description: Is the mapping user defined
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        osdisplayname:
          type: string
          description: Standard display name for the Guest OS
        osnameforhypervisor:
          type: string
          description: Hypervisor specific name for the Guest OS
        ostypeid:
          type: string
          description: The ID of the Guest OS type
    GuestVlan:
      type: object
      properties:
        account:
          type: string
          description: The Account of the guest VLAN range
        allocationstate:
          type: string
          description: The allocation state of the guest VLAN
        domain:
          type: string
          description: The domain name of the guest VLAN range
        domainid:
          type: string
          description: The domain ID of the guest VLAN range
        domainpath:
          type: string
          description: path of the domain to which the guest VLAN range belongs
        id:
          type: integer
          format: int64
          description: The guest VLAN ID
        isdedicated:
          type: boolean
          description: True if the guest VLAN is dedicated to the Account
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        network:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of Networks who use this guest VLAN
        physicalnetworkid:
          type: string
          description: The physical Network ID of the guest VLAN range
        physicalnetworkname:
          type: string
          description: The physical Network name of the guest VLAN range
        project:
          type: string
          description: The project name of the guest VLAN range
        projectid:
          type: string
          description: The project ID of the guest VLAN range
        taken:
          type: string
          x-cloudstack-type: date
          description: Date the guest VLAN was taken. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        vlan:
          type: string
          description: The guest VLAN
        zoneid:
          type: string
          description: The zone ID of the guest VLAN range
        zonename:
          type: string
          description: The zone name of the guest VLAN range
    Guestoslist:
      type: object
      properties:
        osdisplayname:
          type: string
          description: Standard display name for the Guest OS
        osnameforhypervisor:
          type: string
          description: Hypervisor specific name for the Guest OS
    GuiTheme:
      type: object
      properties:
        accountids:
          type: string
          description: A set of account UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
        commonnames:
          type: string
          description: 'A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com'
        created:
          type: string
          x-cloudstack-type: date
          description: When the GUI theme was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        css:
          type: string
          description: The CSS to be retrieved and imported into the GUI when matching the theme access configurations.
        description:
          type: string
          description: Description of the GUI theme.
        domainids:
          type: string
          description: A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.
        id:
          type: string
          description: ID of the custom GUI theme.
        ispublic:
          type: boolean
          description: Defines whether a theme can be retrieved by anyone when only the `commonNames` is informed. If the `domainIds` or `accountIds` is informed, it is considered as `false`.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        jsonconfiguration:
          type: string
          description: The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.
        loginbasedomain:
          type: string
          description: The ACS domain to be used as base for the login when accessing the GUI through the common name defined in the theme. If a common name is not defined, this parameter is ignored on the GUI.
        name:
          type: string
          description: Name of the GUI theme.
        recursivedomains:
          type: boolean
          description: Whether to consider the subdomains of the informed domain IDs.
        removed:
          type: string
          x-cloudstack-type: date
          description: When the GUI theme was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
    HAForHost:
      type: object
      properties:
        haenable:
          type: boolean
          description: If host HA is enabled for the host
        haprovider:
          type: string
          description: The host HA provider
        hastate:
          type: string
          x-cloudstack-type: hastate
          description: The HA state of the host
        hostid:
          type: string
          description: The ID of the host
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        status:
          type: boolean
          description: Operation status
    HSMProfile:
      type: object
      properties:
        account:
          type: string
          description: the account name of the HSM profile owner
        accountid:
          type: string
          description: the account ID of the HSM profile owner
        created:
          type: string
          x-cloudstack-type: date
          description: the date the HSM profile was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: HSM configuration details (sensitive values are encrypted)
        domain:
          type: string
          description: the domain name of the HSM profile owner
        domainid:
          type: string
          description: the domain ID of the HSM profile owner
        domainpath:
          type: string
          description: the domain path of the HSM profile owner
        enabled:
          type: boolean
          description: whether the HSM profile is enabled
        id:
          type: string
          description: the ID of the HSM profile
        ispublic:
          type: boolean
          description: whether this is a system HSM profile available to all users globally
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: the name of the HSM profile
        project:
          type: string
          description: the project name of the HSM profile owner
        projectid:
          type: string
          description: the project ID of the HSM profile owner
        protocol:
          type: string
          description: the protocol of the HSM profile
        state:
          type: string
          description: the state of the HSM profile
        vendor:
          type: string
          description: the vendor name of the HSM profile
        zoneid:
          type: string
          description: the zone ID where the HSM profile is available
        zonename:
          type: string
          description: the zone name where the HSM profile is available
    Healthcheckpolicy:
      type: object
      properties:
        description:
          type: string
          description: The description of the healthcheck policy
        fordisplay:
          type: boolean
          description: Is policy for display to the regular user
        healthcheckinterval:
          type: integer
          format: int32
          description: Amount of time between health checks
        healthcheckthresshold:
          type: integer
          format: int32
          description: Number of consecutive health check success before declaring an Instance healthy
        id:
          type: string
          description: The LB HealthCheck policy ID
        pingpath:
          type: string
          description: The pingpath  of the healthcheck policy
        responsetime:
          type: integer
          format: int32
          description: Time to wait when receiving a response from the health check
        state:
          type: string
          description: The state of the policy
        unhealthcheckthresshold:
          type: integer
          format: int32
          description: Number of consecutive health check failures before declaring an Instance unhealthy.
    Healthcheckresults:
      type: object
      properties:
        checkname:
          type: string
          description: The name of the health check on the router
        checktype:
          type: string
          description: The type of the health check - basic or advanced
        details:
          type: string
          description: Detailed response generated on running health check
        lastupdated:
          type: string
          x-cloudstack-type: date
          description: The date this VPC was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        status:
          type: string
          x-cloudstack-type: routerhealthstatus
          description: 'the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}'
        success:
          type: boolean
          description: The result of the health check if available
    Host:
      type: object
      properties:
        annotation:
          type: string
          description: The last annotation set on this host by an admin
        arch:
          type: string
          description: CPU Arch of the host
        capabilities:
          type: string
          description: Capabilities of the host
        clusterid:
          type: string
          description: The cluster ID of the host
        clustername:
          type: string
          description: The cluster name of the host
        clusterstorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the cluster
        clustertype:
          type: string
          description: The cluster type of the cluster that host belongs to
        cpuallocated:
          type: string
          description: The amount of the host's CPU currently allocated
        cpuallocatedpercentage:
          type: string
          description: The amount of the host's CPU currently allocated in percentage
        cpuallocatedvalue:
          type: integer
          format: int64
          description: The amount of the host's CPU currently allocated in MHz
        cpuallocatedwithoverprovisioning:
          type: string
          description: The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
        cpuloadaverage:
          type: number
          format: double
          description: The average CPU load on the host
        cpunumber:
          type: integer
          format: int32
          description: The CPU number of the host
        cpusockets:
          type: integer
          format: int32
          description: The number of CPU sockets on the host
        cpuspeed:
          type: integer
          format: int64
          description: The CPU speed of the host
        cpuused:
          type: string
          description: The amount of the host's CPU currently used
        cpuwithoverprovisioning:
          type: string
          description: The amount of the host's CPU after applying the cpu.overprovisioning.factor
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Host details in key/value pairs.
        disconnected:
          type: string
          x-cloudstack-type: date
          description: True if the host is disconnected. False otherwise. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        disksizeallocated:
          type: integer
          format: int64
          description: The host's currently allocated disk size
        disksizetotal:
          type: integer
          format: int64
          description: The total disk size of the host
        encryptionsupported:
          type: boolean
          description: True if the host supports encryption
        events:
          type: string
          description: Events available for the host
        explicithosttags:
          type: string
          description: comma-separated list of explicit host tags for the host
        extensionid:
          type: string
          description: The ID of extension for this cluster
        extensionname:
          type: string
          description: The name of extension for this cluster
        gpugroup:
          type: array
          items:
            $ref: '#/components/schemas/Gpugroup'
          x-cloudstack-type: list
          description: GPU cards present in the host
        gputotal:
          type: integer
          format: int64
          description: Total GPUs on the Host
        gpuused:
          type: integer
          format: int64
          description: Used GPUs on the Host
        guestosrule:
          type: string
          description: the guest OS rule
        hahost:
          type: boolean
          description: True if the host is Ha host (dedicated to Instances started by HA process; false otherwise
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hasenoughcapacity:
          type: boolean
          description: True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
        hostha:
          type: object
          x-cloudstack-type: hostharesponse
          description: The host HA information information
        hosttags:
          type: string
          description: Comma-separated list of tags for the host
        hypervisor:
          type: string
          description: The host hypervisor
        hypervisorversion:
          type: string
          description: The hypervisor version
        id:
          type: string
          description: The ID of the host
        implicithosttags:
          type: string
          description: comma-separated list of implicit host tags for the host
        instanceconversionsupported:
          type: boolean
          description: true if the host supports instance conversion (using virt-v2v)
        ipaddress:
          type: string
          description: The IP address of the host
        islocalstorageactive:
          type: boolean
          description: True if local storage is active, false otherwise
        istagarule:
          type: boolean
          description: Whether the informed tag is a JS interpretable rule or not.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastannotated:
          type: string
          x-cloudstack-type: date
          description: The last time this host was annotated. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        lastpinged:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was last pinged. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        managementserverid:
          type: string
          description: The management server ID of the host
        managementservername:
          type: string
          description: the management server name of the host
        memoryallocated:
          type: integer
          format: int64
          description: The amount of the host's memory currently allocated
        memoryallocatedbytes:
          type: integer
          format: int64
          description: The amount of the host's memory currently allocated in bytes
        memoryallocatedpercentage:
          type: string
          description: The amount of the host's memory currently allocated in percentage
        memorytotal:
          type: integer
          format: int64
          description: The memory total of the host, this parameter is deprecated use memorywithoverprovisioning
        memoryused:
          type: integer
          format: int64
          description: The amount of the host's memory currently used
        memorywithoverprovisioning:
          type: string
          description: The amount of the host's memory after applying the mem.overprovisioning.factor
        msid:
          type: integer
          format: int64
          description: (only for details=core) the msid of the host's management server
        name:
          type: string
          description: The name of the host
        networkkbsread:
          type: integer
          format: int64
          description: The incoming Network traffic on the host
        networkkbswrite:
          type: integer
          format: int64
          description: The outgoing Network traffic on the host
        oscategoryid:
          type: string
          description: The OS category ID of the host
        oscategoryname:
          type: string
          description: The OS category name of the host
        outofbandmanagement:
          type: object
          x-cloudstack-type: outofbandmanagementresponse
          description: The host out-of-band management information
        podid:
          type: string
          description: The Pod ID of the host
        podname:
          type: string
          description: The Pod name of the host
        podstorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the pod
        removed:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        resourcestate:
          type: string
          description: The resource state of the host
        state:
          type: string
          x-cloudstack-type: status
          description: The state of the host
        storageaccessgroups:
          type: string
          description: comma-separated list of storage access groups for the host
        suitableformigration:
          type: boolean
          description: True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
        type:
          type: string
          x-cloudstack-type: type
          description: The host type
        ueficapability:
          type: boolean
          description: True if the host has capability to support UEFI boot
        username:
          type: string
          description: The admin that annotated this host
        version:
          type: string
          description: The host version
        virtualmachineid:
          type: string
          description: the virtual machine id for host type ConsoleProxy and SecondaryStorageVM
        zoneid:
          type: string
          description: The Zone ID of the host
        zonename:
          type: string
          description: The Zone name of the host
        zonestorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the zone
    HostTag:
      type: object
      properties:
        hostid:
          type: string
          description: The host ID of the host tag
        id:
          type: string
          description: The ID of the host tag
        isimplicit:
          type: boolean
          description: true if the host tag is implicit
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the host tag
    HostsForMigration:
      type: object
      properties:
        annotation:
          type: string
          description: The last annotation set on this host by an admin
        arch:
          type: string
          description: CPU Arch of the host
        capabilities:
          type: string
          description: Capabilities of the host
        clusterid:
          type: string
          description: The cluster ID of the host
        clustername:
          type: string
          description: The cluster name of the host
        clusterstorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the cluster
        clustertype:
          type: string
          description: The cluster type of the cluster that host belongs to
        cpuallocated:
          type: string
          description: The amount of the host's CPU currently allocated
        cpuallocatedpercentage:
          type: string
          description: The amount of the host's CPU currently allocated in percentage
        cpuallocatedvalue:
          type: integer
          format: int64
          description: The amount of the host's CPU currently allocated in MHz
        cpuallocatedwithoverprovisioning:
          type: string
          description: The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
        cpuloadaverage:
          type: number
          format: double
          description: The average CPU load on the host
        cpunumber:
          type: integer
          format: int32
          description: The CPU number of the host
        cpusockets:
          type: integer
          format: int32
          description: The number of CPU sockets on the host
        cpuspeed:
          type: integer
          format: int64
          description: The CPU speed of the host
        cpuused:
          type: string
          description: The amount of the host's CPU currently used
        cpuwithoverprovisioning:
          type: string
          description: The amount of the host's CPU after applying the cpu.overprovisioning.factor
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Host details in key/value pairs.
        disconnected:
          type: string
          x-cloudstack-type: date
          description: True if the host is disconnected. False otherwise. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        disksizeallocated:
          type: integer
          format: int64
          description: The host's currently allocated disk size
        disksizetotal:
          type: integer
          format: int64
          description: The total disk size of the host
        encryptionsupported:
          type: boolean
          description: True if the host supports encryption
        events:
          type: string
          description: Events available for the host
        explicithosttags:
          type: string
          description: comma-separated list of explicit host tags for the host
        extensionid:
          type: string
          description: The ID of extension for this cluster
        extensionname:
          type: string
          description: The name of extension for this cluster
        gpugroup:
          type: array
          items:
            $ref: '#/components/schemas/Gpugroup'
          x-cloudstack-type: list
          description: GPU cards present in the host
        gputotal:
          type: integer
          format: int64
          description: Total GPUs on the Host
        gpuused:
          type: integer
          format: int64
          description: Used GPUs on the Host
        guestosrule:
          type: string
          description: the guest OS rule
        hahost:
          type: boolean
          description: True if the host is Ha host (dedicated to Instances started by HA process; false otherwise
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hasenoughcapacity:
          type: boolean
          description: True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
        hostha:
          type: object
          x-cloudstack-type: hostharesponse
          description: The host HA information information
        hosttags:
          type: string
          description: Comma-separated list of tags for the host
        hypervisor:
          type: string
          description: The host hypervisor
        hypervisorversion:
          type: string
          description: The hypervisor version
        id:
          type: string
          description: The ID of the host
        implicithosttags:
          type: string
          description: comma-separated list of implicit host tags for the host
        instanceconversionsupported:
          type: boolean
          description: true if the host supports instance conversion (using virt-v2v)
        ipaddress:
          type: string
          description: The IP address of the host
        islocalstorageactive:
          type: boolean
          description: True if local storage is active, false otherwise
        istagarule:
          type: boolean
          description: Whether the informed tag is a JS interpretable rule or not.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastannotated:
          type: string
          x-cloudstack-type: date
          description: The last time this host was annotated. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        lastpinged:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was last pinged. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        managementserverid:
          type: string
          description: The management server ID of the host
        managementservername:
          type: string
          description: the management server name of the host
        memoryallocated:
          type: integer
          format: int64
          description: The amount of the host's memory currently allocated
        memoryallocatedbytes:
          type: integer
          format: int64
          description: The amount of the host's memory currently allocated in bytes
        memoryallocatedpercentage:
          type: string
          description: The amount of the host's memory currently allocated in percentage
        memorytotal:
          type: integer
          format: int64
          description: The memory total of the host, this parameter is deprecated use memorywithoverprovisioning
        memoryused:
          type: integer
          format: int64
          description: The amount of the host's memory currently used
        memorywithoverprovisioning:
          type: string
          description: The amount of the host's memory after applying the mem.overprovisioning.factor
        msid:
          type: integer
          format: int64
          description: (only for details=core) the msid of the host's management server
        name:
          type: string
          description: The name of the host
        networkkbsread:
          type: integer
          format: int64
          description: The incoming Network traffic on the host
        networkkbswrite:
          type: integer
          format: int64
          description: The outgoing Network traffic on the host
        oscategoryid:
          type: string
          description: The OS category ID of the host
        oscategoryname:
          type: string
          description: The OS category name of the host
        outofbandmanagement:
          type: object
          x-cloudstack-type: outofbandmanagementresponse
          description: The host out-of-band management information
        podid:
          type: string
          description: The Pod ID of the host
        podname:
          type: string
          description: The Pod name of the host
        podstorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the pod
        removed:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        requiresStorageMotion:
          type: boolean
          description: True if migrating an Instance to this host requires storage motion, false otherwise
        resourcestate:
          type: string
          description: The resource state of the host
        state:
          type: string
          x-cloudstack-type: status
          description: The state of the host
        storageaccessgroups:
          type: string
          description: comma-separated list of storage access groups for the host
        suitableformigration:
          type: boolean
          description: True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
        type:
          type: string
          x-cloudstack-type: type
          description: The host type
        ueficapability:
          type: boolean
          description: True if the host has capability to support UEFI boot
        username:
          type: string
          description: The admin that annotated this host
        version:
          type: string
          description: The host version
        virtualmachineid:
          type: string
          description: the virtual machine id for host type ConsoleProxy and SecondaryStorageVM
        zoneid:
          type: string
          description: The Zone ID of the host
        zonename:
          type: string
          description: The Zone name of the host
        zonestorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the zone
    HostsMetric:
      type: object
      properties:
        annotation:
          type: string
          description: The last annotation set on this host by an admin
        arch:
          type: string
          description: CPU Arch of the host
        capabilities:
          type: string
          description: Capabilities of the host
        clusterid:
          type: string
          description: The cluster ID of the host
        clustername:
          type: string
          description: The cluster name of the host
        clusterstorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the cluster
        clustertype:
          type: string
          description: The cluster type of the cluster that host belongs to
        cpuallocated:
          type: string
          description: The amount of the host's CPU currently allocated
        cpuallocateddisablethreshold:
          type: boolean
          description: CPU allocated disable threshold exceeded
        cpuallocatedghz:
          type: string
          description: The total cpu allocated in Ghz
        cpuallocatedpercentage:
          type: string
          description: The amount of the host's CPU currently allocated in percentage
        cpuallocatedthreshold:
          type: boolean
          description: CPU allocated notification threshold exceeded
        cpuallocatedvalue:
          type: integer
          format: int64
          description: The amount of the host's CPU currently allocated in MHz
        cpuallocatedwithoverprovisioning:
          type: string
          description: The amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor
        cpudisablethreshold:
          type: boolean
          description: CPU usage disable threshold exceeded
        cpuloadaverage:
          type: number
          format: double
          description: The average CPU load on the host
        cpunumber:
          type: integer
          format: int32
          description: The CPU number of the host
        cpusockets:
          type: integer
          format: int32
          description: The number of CPU sockets on the host
        cpuspeed:
          type: integer
          format: int64
          description: The CPU speed of the host
        cputhreshold:
          type: boolean
          description: CPU usage notification threshold exceeded
        cputotalghz:
          type: string
          description: The total cpu capacity in Ghz
        cpuused:
          type: string
          description: The amount of the host's CPU currently used
        cpuusedghz:
          type: string
          description: The total cpu used in Ghz
        cpuwithoverprovisioning:
          type: string
          description: The amount of the host's CPU after applying the cpu.overprovisioning.factor
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Host details in key/value pairs.
        disconnected:
          type: string
          x-cloudstack-type: date
          description: True if the host is disconnected. False otherwise. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        disksizeallocated:
          type: integer
          format: int64
          description: The host's currently allocated disk size
        disksizetotal:
          type: integer
          format: int64
          description: The total disk size of the host
        encryptionsupported:
          type: boolean
          description: True if the host supports encryption
        events:
          type: string
          description: Events available for the host
        explicithosttags:
          type: string
          description: comma-separated list of explicit host tags for the host
        extensionid:
          type: string
          description: The ID of extension for this cluster
        extensionname:
          type: string
          description: The name of extension for this cluster
        gpugroup:
          type: array
          items:
            $ref: '#/components/schemas/Gpugroup'
          x-cloudstack-type: list
          description: GPU cards present in the host
        gputotal:
          type: integer
          format: int64
          description: Total GPUs on the Host
        gpuused:
          type: integer
          format: int64
          description: Used GPUs on the Host
        guestosrule:
          type: string
          description: the guest OS rule
        hahost:
          type: boolean
          description: True if the host is Ha host (dedicated to Instances started by HA process; false otherwise
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hasenoughcapacity:
          type: boolean
          description: True if this host has enough CPU and RAM capacity to migrate an Instance to it, false otherwise
        hostha:
          type: object
          x-cloudstack-type: hostharesponse
          description: The host HA information information
        hosttags:
          type: string
          description: Comma-separated list of tags for the host
        hypervisor:
          type: string
          description: The host hypervisor
        hypervisorversion:
          type: string
          description: The hypervisor version
        id:
          type: string
          description: The ID of the host
        implicithosttags:
          type: string
          description: comma-separated list of implicit host tags for the host
        instanceconversionsupported:
          type: boolean
          description: true if the host supports instance conversion (using virt-v2v)
        instances:
          type: string
          description: Instances on the host
        ipaddress:
          type: string
          description: The IP address of the host
        islocalstorageactive:
          type: boolean
          description: True if local storage is active, false otherwise
        istagarule:
          type: boolean
          description: Whether the informed tag is a JS interpretable rule or not.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastannotated:
          type: string
          x-cloudstack-type: date
          description: The last time this host was annotated. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        lastpinged:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was last pinged. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        managementserverid:
          type: string
          description: The management server ID of the host
        managementservername:
          type: string
          description: the management server name of the host
        memoryallocated:
          type: integer
          format: int64
          description: The amount of the host's memory currently allocated
        memoryallocatedbytes:
          type: integer
          format: int64
          description: The amount of the host's memory currently allocated in bytes
        memoryallocateddisablethreshold:
          type: boolean
          description: Memory allocated disable threshold exceeded
        memoryallocatedgb:
          type: string
          description: The total memory allocated in GiB
        memoryallocatedpercentage:
          type: string
          description: The amount of the host's memory currently allocated in percentage
        memoryallocatedthreshold:
          type: boolean
          description: Memory allocated notification threshold exceeded
        memorydisablethreshold:
          type: boolean
          description: Memory usage disable threshold exceeded
        memorythreshold:
          type: boolean
          description: Memory usage notification threshold exceeded
        memorytotal:
          type: integer
          format: int64
          description: The memory total of the host, this parameter is deprecated use memorywithoverprovisioning
        memorytotalgb:
          type: string
          description: The total memory capacity in GiB
        memoryused:
          type: integer
          format: int64
          description: The amount of the host's memory currently used
        memoryusedgb:
          type: string
          description: The total memory used in GiB
        memorywithoverprovisioning:
          type: string
          description: The amount of the host's memory after applying the mem.overprovisioning.factor
        msid:
          type: integer
          format: int64
          description: (only for details=core) the msid of the host's management server
        name:
          type: string
          description: The name of the host
        networkkbsread:
          type: integer
          format: int64
          description: The incoming Network traffic on the host
        networkkbswrite:
          type: integer
          format: int64
          description: The outgoing Network traffic on the host
        networkread:
          type: string
          description: Network read in GiB
        networkwrite:
          type: string
          description: Network write in GiB
        oscategoryid:
          type: string
          description: The OS category ID of the host
        oscategoryname:
          type: string
          description: The OS category name of the host
        outofbandmanagement:
          type: object
          x-cloudstack-type: outofbandmanagementresponse
          description: The host out-of-band management information
        podid:
          type: string
          description: The Pod ID of the host
        podname:
          type: string
          description: The Pod name of the host
        podstorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the pod
        powerstate:
          type: string
          x-cloudstack-type: powerstate
          description: Out-of-band management power state
        removed:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        resourcestate:
          type: string
          description: The resource state of the host
        state:
          type: string
          x-cloudstack-type: status
          description: The state of the host
        storageaccessgroups:
          type: string
          description: comma-separated list of storage access groups for the host
        suitableformigration:
          type: boolean
          description: True if this host is suitable(has enough capacity and satisfies all conditions like hosttags, max guests Instance limit etc) to migrate an Instance to it , false otherwise
        systeminstances:
          type: string
          description: system vm instances on the host
        type:
          type: string
          x-cloudstack-type: type
          description: The host type
        ueficapability:
          type: boolean
          description: True if the host has capability to support UEFI boot
        username:
          type: string
          description: The admin that annotated this host
        version:
          type: string
          description: The host version
        virtualmachineid:
          type: string
          description: the virtual machine id for host type ConsoleProxy and SecondaryStorageVM
        zoneid:
          type: string
          description: The Zone ID of the host
        zonename:
          type: string
          description: The Zone name of the host
        zonestorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the zone
    Hostsskipped:
      type: object
      properties:
        hostid:
          type: string
          description: The ID of the skipped host
        hostname:
          type: string
          description: The name of the skipped host
        reason:
          type: string
          description: The reason to skip the host
    Hostsupdated:
      type: object
      properties:
        enddate:
          type: string
          description: End date of the update on the host
        hostid:
          type: string
          description: The ID of the updated host
        hostname:
          type: string
          description: The name of the updated host
        output:
          type: string
          description: Output of the maintenance script on the host
        startdate:
          type: string
          description: Start date of the update on the host
    HypervisorCapability:
      type: object
      properties:
        hypervisor:
          type: string
          description: The hypervisor type
        hypervisorversion:
          type: string
          description: The hypervisor version
        id:
          type: string
          description: The hypervisor capability ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        maxdatavolumeslimit:
          type: integer
          format: int32
          description: The maximum number of Data Volumes that can be attached for this hypervisor
        maxguestslimit:
          type: integer
          format: int64
          description: The maximum number of guest Instances recommended for this hypervisor
        maxhostspercluster:
          type: integer
          format: int32
          description: The maximum number of Hosts per cluster for this hypervisor
        securitygroupenabled:
          type: boolean
          description: True if security group is supported
        storagemotionenabled:
          type: boolean
          description: True if storage motion is supported
        vmsnapshotenabled:
          type: boolean
          description: True if Instance Snapshots are enabled for this hypervisor
    HypervisorGuestOsName:
      type: object
      properties:
        guestoscount:
          type: integer
          format: int32
          description: The guest OS count of the hypervisor
        guestoslist:
          type: array
          items:
            $ref: '#/components/schemas/Guestoslist'
          x-cloudstack-type: list
          description: The guest OS list of the hypervisor
        hypervisor:
          type: string
          description: The hypervisor
        hypervisorversion:
          type: string
          description: Version of the hypervisor for guest os names
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    ImageStore:
      type: object
      properties:
        disksizetotal:
          type: integer
          format: int64
          description: The total disk size of the host
        disksizeused:
          type: integer
          format: int64
          description: The host's currently used disk size
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The ID of the image store
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the image store
        protocol:
          type: string
          description: The protocol of the image store
        providername:
          type: string
          description: The provider name of the image store
        readonly:
          type: boolean
          description: Defines if store is read-only
        scope:
          type: string
          x-cloudstack-type: scopetype
          description: The scope of the image store
        url:
          type: string
          description: The URL of the image store
        zoneid:
          type: string
          description: The Zone ID of the image store
        zonename:
          type: string
          description: The Zone name of the image store
    ImportVmTask:
      type: object
      properties:
        account:
          type: string
          description: the account name
        accountid:
          type: string
          description: the ID of account
        convertinstancehostid:
          type: string
          description: the ID of the host on which the instance is being converted
        convertinstancehostname:
          type: string
          description: the name of the host on which the instance is being converted
        created:
          type: string
          x-cloudstack-type: date
          description: the create date of the importing task. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        datacentername:
          type: string
          description: the datacenter name of the importing VM task
        description:
          type: string
          description: the current step description on the importing VM task
        displayname:
          type: string
          description: the display name of the importing VM
        duration:
          type: string
          description: the total task duration
        id:
          type: string
          description: the ID of importing task
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastupdated:
          type: string
          x-cloudstack-type: date
          description: the last updated date of the importing task. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        sourcevmname:
          type: string
          description: the source VM name
        state:
          type: string
          description: the state of the importing VM task
        step:
          type: string
          description: the current step on the importing VM task
        stepduration:
          type: string
          description: the duration of the current step
        vcenter:
          type: string
          description: the vcenter name of the importing VM task
        virtualmachineid:
          type: string
          description: the ID of the imported VM (after task is completed)
        zoneid:
          type: string
          description: the Zone ID
        zonename:
          type: string
          description: the Zone name
    Infrastructure:
      type: object
      properties:
        alerts:
          type: integer
          format: int32
          description: Number of Alerts
        backuprepositories:
          type: integer
          format: int32
          description: Number of backup repositories
        clusters:
          type: integer
          format: int32
          description: Number of clusters
        cpusockets:
          type: integer
          format: int32
          description: Number of cpu sockets
        hosts:
          type: integer
          format: int32
          description: Number of hypervisor hosts
        ilbvms:
          type: integer
          format: int32
          description: Number of internal LBs
        imagestores:
          type: integer
          format: int32
          description: Number of images stores
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        managementservers:
          type: integer
          format: int32
          description: Number of management servers
        objectstores:
          type: integer
          format: int32
          description: Number of object stores
        pods:
          type: integer
          format: int32
          description: Number of pods
        routers:
          type: integer
          format: int32
          description: Number of routers
        storagepools:
          type: integer
          format: int32
          description: Number of storage pools
        systemvms:
          type: integer
          format: int32
          description: Number of systemvms
        zones:
          type: integer
          format: int32
          description: Number of zones
    Ingressrule:
      type: object
      properties:
        account:
          type: string
          description: Account owning the security group rule
        cidr:
          type: string
          description: The CIDR notation for the base IP address of the security group rule
        endport:
          type: integer
          format: int32
          description: The ending IP of the security group rule
        icmpcode:
          type: integer
          format: int32
          description: The code for the ICMP message response
        icmptype:
          type: integer
          format: int32
          description: The type of the ICMP message response
        protocol:
          type: string
          description: The protocol of the security group rule
        ruleid:
          type: string
          description: The ID of the security group rule
        securitygroupname:
          type: string
          description: Security group name
        startport:
          type: integer
          format: int32
          description: The starting IP of the security group rule
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated with the rule
    InstanceGroup:
      type: object
      properties:
        account:
          type: string
          description: The Account owning the Instance group
        created:
          type: string
          x-cloudstack-type: date
          description: Time and date the Instance group was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: The domain name of the Instance group
        domainid:
          type: string
          description: The domain ID of the Instance group
        domainpath:
          type: string
          description: path of the Domain the instance group belongs to
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The ID of the Instance group
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the Instance group
        project:
          type: string
          description: The project name of the Instance group
        projectid:
          type: string
          description: The project ID of the Instance group
    InternalLoadBalancerElement:
      type: object
      properties:
        enabled:
          type: boolean
          description: Enabled/Disabled the element
        id:
          type: string
          description: The ID of the internal Load balancer element
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        nspid:
          type: string
          description: The physical Network service provider ID of the element
    IpAddress:
      type: object
      properties:
        account:
          type: string
          description: The Account the public IP address is associated with
        allocated:
          type: string
          x-cloudstack-type: date
          description: Date the public IP address was acquired. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        associatednetworkid:
          type: string
          description: The ID of the Network associated with the IP address
        associatednetworkname:
          type: string
          description: The name of the Network associated with the IP address
        domain:
          type: string
          description: The domain the public IP address is associated with
        domainid:
          type: string
          description: The domain ID the public IP address is associated with
        domainpath:
          type: string
          description: path of the domain to which the public IP address belongs
        fordisplay:
          type: boolean
          description: Is public IP for display to the regular user
        forprovider:
          type: boolean
          description: true if range is dedicated for external network providers
        forsystemvms:
          type: boolean
          description: true if range is dedicated for System VMs
        forvirtualnetwork:
          type: boolean
          description: The virtual Network for the IP address
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hasrules:
          type: boolean
          description: Whether the IP address has Firewall/PortForwarding/LoadBalancing rules defined
        id:
          type: string
          description: Public IP address ID
        ipaddress:
          type: string
          description: Public IP address
        isportable:
          type: boolean
          description: Is public IP portable across the zones
        issourcenat:
          type: boolean
          description: True if the IP address is a source NAT address, false otherwise
        isstaticnat:
          type: boolean
          description: True if this IP is for static NAT, false otherwise
        issystem:
          type: boolean
          description: True if this IP is system IP (was allocated as a part of deployVm or createLbRule)
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        networkid:
          type: string
          description: The ID of the Network where IP belongs to
        networkname:
          type: string
          description: The name of the Network where IP belongs to
        physicalnetworkid:
          type: string
          description: The physical Network this belongs to
        project:
          type: string
          description: The project name of the address
        projectid:
          type: string
          description: The project id of the IP address
        purpose:
          type: string
          description: Purpose of the IP address. In Acton this value is not null for IPs with isSystem=true, and can have either StaticNat or LB value
        state:
          type: string
          description: 'State of the IP address. Can be: Allocating, Allocated, Releasing, Reserved and Free'
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with IP address
        virtualmachinedisplayname:
          type: string
          description: Instance display name the IP address is assigned to (not null only for static NAT IP)
        virtualmachineid:
          type: string
          description: Instance id the IP address is assigned to
        virtualmachinename:
          type: string
          description: Instance name the IP address is assigned to
        virtualmachinetype:
          type: string
          description: Instance type the IP address is assigned to
        vlanid:
          type: string
          description: The ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only
        vlanname:
          type: string
          description: The VLAN associated with the IP address
        vmipaddress:
          type: string
          description: Instance (DNAT) IP address (not null only for static NAT IP)
        vpcid:
          type: string
          description: VPC ID the IP belongs to
        vpcname:
          type: string
          description: VPC name the IP belongs to
        zoneid:
          type: string
          description: The ID of the zone the public IP address belongs to
        zonename:
          type: string
          description: The name of the zone the public IP address belongs to
    IpToNic:
      type: object
      properties:
        description:
          type: string
          description: Description of the secondary IP address
        id:
          type: string
          description: The ID of the secondary private IP addr
        ipaddress:
          type: string
          description: Secondary IP address
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        networkid:
          type: string
          description: The ID of the Network
        nicid:
          type: string
          description: The ID of the NIC
        secondaryip:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of Secondary IPv4 addr of NIC
        virtualmachineid:
          type: string
          description: The ID of the Instance
    Ipranges:
      type: object
      properties:
        cidr:
          type: string
          description: The CIDR for the range
        endip:
          type: string
          description: The ending IP for the range
        forsystemvms:
          type: string
          description: Indicates if range is dedicated for CPVM and SSVM
        gateway:
          type: string
          description: The gateway for the range
        startip:
          type: string
          description: The starting IP for the range
        vlanid:
          type: string
          description: Indicates VLAN ID for the range
    Ipv4SubnetForZone:
      type: object
      properties:
        account:
          type: string
          description: the account of the IPv4 subnet
        created:
          type: string
          x-cloudstack-type: date
          description: date when this IPv4 subnet was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: the domain name of the IPv4 subnet
        domainid:
          type: string
          description: the domain ID of the IPv4 subnet
        id:
          type: string
          description: id of the guest IPv4 subnet
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        project:
          type: string
          description: the project name of the IPv4 subnet
        projectid:
          type: string
          description: the project id of the IPv4 subnet
        subnet:
          type: string
          description: guest IPv4 subnet
        zoneid:
          type: string
          description: id of zone to which the IPv4 subnet belongs to.
        zonename:
          type: string
          description: name of zone to which the IPv4 subnet belongs to.
    Ipv6FirewallRule:
      type: object
      properties:
        cidrlist:
          type: string
          description: The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
        fordisplay:
          type: boolean
          description: Is firewall for display to the regular user
        id:
          type: string
          description: The ID of the port forwarding rule
        ipaddress:
          type: string
          description: The public IP address for the port forwarding rule
        ipaddressid:
          type: string
          description: The public IP address id for the port forwarding rule
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        networkid:
          type: string
          description: The ID of the guest Network the port forwarding rule belongs to
        networkname:
          type: string
          description: The Name of the guest Network the port forwarding rule belongs to
        privateendport:
          type: string
          description: The ending port of port forwarding rule's private port range
        privateport:
          type: string
          description: The starting port of port forwarding rule's private port range
        protocol:
          type: string
          description: The protocol of the port forwarding rule
        publicendport:
          type: string
          description: The ending port of port forwarding rule's private port range
        publicport:
          type: string
          description: The starting port of port forwarding rule's public port range
        state:
          type: string
          description: The state of the rule
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with the rule
        virtualmachinedisplayname:
          type: string
          description: The Instance display name for the port forwarding rule
        virtualmachineid:
          type: string
          description: The Instance ID for the port forwarding rule
        virtualmachinename:
          type: string
          description: The Instance name for the port forwarding rule
        vmguestip:
          type: string
          description: The Instance IP address for the port forwarding rule
    Isos:
      type: object
      properties:
        bootable:
          type: boolean
          description: Whether this is the bootable ISO for the VM
        deviceseq:
          type: integer
          format: int32
          description: The cdrom slot that holds this ISO (3=hdc, 4=hdd, ...)
        displaytext:
          type: string
          description: The display text of the attached ISO
        id:
          type: string
          description: The ID of the attached ISO
        name:
          type: string
          description: The name of the attached ISO
    IssueCertificateResult:
      type: object
      properties:
        cacertificates:
          type: string
          description: The CA certificate(s)
        certificate:
          type: string
          description: The client certificate
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        privatekey:
          type: string
          description: Private key for the certificate
    KMSKey:
      type: object
      properties:
        account:
          type: string
          description: the account owning the key
        accountid:
          type: string
          description: the account ID owning the key
        algorithm:
          type: string
          description: the encryption algorithm
        created:
          type: string
          x-cloudstack-type: date
          description: the creation timestamp. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: the description of the key
        domain:
          type: string
          description: the domain name of the key
        domainid:
          type: string
          description: the domain ID of the key
        domainpath:
          type: string
          description: the domain path of the key
        enabled:
          type: boolean
          description: whether the key is enabled
        hsmprofile:
          type: string
          description: the zone name where the key is valid
        hsmprofileid:
          type: string
          description: the zone ID where the key is valid
        id:
          type: string
          description: the UUID of the key
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        keklabel:
          type: string
          description: the provider-specific KEK label (admin only)
        keybits:
          type: integer
          format: int32
          description: the key size in bits
        name:
          type: string
          description: the name of the key
        project:
          type: string
          description: the project name of the key
        projectid:
          type: string
          description: the project ID of the key
        version:
          type: integer
          format: int32
          description: the key size in bits
        zoneid:
          type: string
          description: the zone ID where the key is valid
        zonename:
          type: string
          description: the zone name where the key is valid
    KubernetesCluster:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the Kubernetes cluster
        associatednetworkname:
          type: string
          description: The name of the network of the Kubernetes cluster
        autoscalingenabled:
          type: boolean
          description: Whether autoscaling is enabled for the cluster
        clustertype:
          type: string
          x-cloudstack-type: clustertype
          description: The type of the cluster
        cniconfigname:
          type: string
          description: Name of CNI Configuration associated with the cluster
        cniconfigurationid:
          type: string
          description: ID of CNI Configuration associated with the cluster
        consoleendpoint:
          type: string
          description: URL end point for the Kubernetes cluster dashboard UI
        controlaffinitygroupids:
          type: string
          description: The IDs of affinity groups associated with control nodes
        controlaffinitygroupnames:
          type: string
          description: The names of affinity groups associated with control nodes
        controlnodes:
          type: integer
          format: int64
          description: The control nodes count for the Kubernetes cluster
        controlofferingid:
          type: string
          description: the ID of the service offering of the control nodes on the Kubernetes cluster
        controlofferingname:
          type: string
          description: the name of the service offering of the control nodes on the Kubernetes cluster
        cpunumber:
          type: string
          description: The cpu cores of the Kubernetes cluster
        created:
          type: string
          x-cloudstack-type: date
          description: The date when this Kubernetes cluster was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        csienabled:
          type: boolean
          description: Indicates if the CloudStack CSI driver has been setup in the cluster
        description:
          type: string
          description: The description of the Kubernetes cluster
        domain:
          type: string
          description: The name of the domain in which the Kubernetes cluster exists
        domainid:
          type: string
          description: The ID of the domain in which the Kubernetes cluster exists
        domainpath:
          type: string
          description: Path of the domain to which the Kubernetes cluster belongs
        endpoint:
          type: string
          description: URL end point for the Kubernetes cluster
        etcdaffinitygroupids:
          type: string
          description: The IDs of affinity groups associated with etcd nodes
        etcdaffinitygroupnames:
          type: string
          description: The names of affinity groups associated with etcd nodes
        etcdips:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Public IP Addresses of the etcd nodes
        etcdnodes:
          type: integer
          format: int64
          description: the number of the etcd nodes on the Kubernetes cluster
        etcdofferingid:
          type: string
          description: the ID of the service offering of the etcd nodes on the Kubernetes cluster
        etcdofferingname:
          type: string
          description: the name of the service offering of the etcd nodes on the Kubernetes cluster
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The ID of the Kubernetes cluster
        ipaddress:
          type: string
          description: Public IP Address of the cluster
        ipaddressid:
          type: string
          description: Public IP Address ID of the cluster
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        keypair:
          type: string
          description: Keypair details
        kubernetesversionid:
          type: string
          description: The ID of the Kubernetes version for the Kubernetes cluster
        kubernetesversionname:
          type: string
          description: The name of the Kubernetes version for the Kubernetes cluster
        masternodes:
          type: integer
          format: int64
          description: The master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.
        maxsize:
          type: integer
          format: int64
          description: Maximum size of the cluster
        memory:
          type: string
          description: The memory the Kubernetes cluster
        minsize:
          type: integer
          format: int64
          description: Minimum size of the cluster
        name:
          type: string
          description: The name of the Kubernetes cluster
        networkid:
          type: string
          description: The ID of the network of the Kubernetes cluster
        project:
          type: string
          description: The project name of the Kubernetes cluster
        projectid:
          type: string
          description: The project id of the Kubernetes cluster
        serviceofferingid:
          type: string
          description: The ID of the service offering of the Kubernetes cluster
        serviceofferingname:
          type: string
          description: The name of the service offering of the Kubernetes cluster
        size:
          type: integer
          format: int64
          description: The size (worker nodes count) of the Kubernetes cluster
        state:
          type: string
          description: The state of the Kubernetes cluster
        templateid:
          type: string
          description: The ID of the Template of the Kubernetes cluster
        templatename:
          type: string
          description: the name of the template of the Kubernetes cluster
        virtualmachines:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of virtualmachines associated with this Kubernetes cluster
        workeraffinitygroupids:
          type: string
          description: The IDs of affinity groups associated with worker nodes
        workeraffinitygroupnames:
          type: string
          description: The names of affinity groups associated with worker nodes
        workerofferingid:
          type: string
          description: the ID of the service offering of the worker nodes on the Kubernetes cluster
        workerofferingname:
          type: string
          description: the name of the service offering of the worker nodes on the Kubernetes cluster
        zoneid:
          type: string
          description: The name of the zone of the Kubernetes cluster
        zonename:
          type: string
          description: The name of the zone of the Kubernetes cluster
    KubernetesClusterConfig:
      type: object
      properties:
        configdata:
          type: string
          description: The config data of the cluster
        id:
          type: string
          description: The ID of the container cluster
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the container cluster
    KubernetesSupportedVersion:
      type: object
      properties:
        arch:
          type: string
          description: the arch of the binaries ISO for Kubernetes supported version
        created:
          type: string
          x-cloudstack-type: date
          description: The date when this Kubernetes supported version was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        directdownload:
          type: boolean
          description: 'KVM Only: true if the ISO for the Kubernetes supported version is directly downloaded to Primary Storage bypassing Secondary Storage'
        id:
          type: string
          description: The ID of the Kubernetes supported version
        isoid:
          type: string
          description: The ID of the binaries ISO for Kubernetes supported version
        isoname:
          type: string
          description: The name of the binaries ISO for Kubernetes supported version
        isostate:
          type: string
          description: The state of the binaries ISO for Kubernetes supported version
        isourl:
          type: string
          description: the URL of the binaries ISO for Kubernetes supported version
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        mincpunumber:
          type: integer
          format: int32
          description: The minimum number of CPUs needed for the Kubernetes supported version
        minmemory:
          type: integer
          format: int32
          description: The minimum RAM size in MB needed for the Kubernetes supported version
        name:
          type: string
          description: Name of the Kubernetes supported version
        semanticversion:
          type: string
          description: Kubernetes semantic version
        state:
          type: string
          description: The enabled or disabled state of the Kubernetes supported version
        supportsautoscaling:
          type: boolean
          description: Whether Kubernetes supported version supports Autoscaling
        supportsha:
          type: boolean
          description: Whether Kubernetes supported version supports HA, multi-control nodes
        zoneid:
          type: string
          description: The ID of the zone in which Kubernetes supported version is available
        zonename:
          type: string
          description: The name of the zone in which Kubernetes supported version is available
    LBHealthCheckPolicy:
      type: object
      properties:
        account:
          type: string
          description: The Account of the HealthCheck policy
        domain:
          type: string
          description: The domain of the HealthCheck policy
        domainid:
          type: string
          description: The domain ID of the HealthCheck policy
        healthcheckpolicy:
          type: array
          items:
            $ref: '#/components/schemas/Healthcheckpolicy'
          x-cloudstack-type: list
          description: The list of healthcheckpolicies
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lbruleid:
          type: string
          description: The LB rule ID
        zoneid:
          type: string
          description: The ID of the zone the HealthCheck policy belongs to
    LBStickinessPolicy:
      type: object
      properties:
        account:
          type: string
          description: The Account of the Stickiness policy
        description:
          type: string
          description: The description of the Stickiness policy
        domain:
          type: string
          description: The domain of the Stickiness policy
        domainid:
          type: string
          description: The domain ID of the Stickiness policy
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lbruleid:
          type: string
          description: The LB rule ID
        name:
          type: string
          description: The name of the Stickiness policy
        state:
          type: string
          description: The state of the policy
        stickinesspolicy:
          type: array
          items:
            $ref: '#/components/schemas/Stickinesspolicy'
          x-cloudstack-type: list
          description: The list of stickinesspolicies
        zoneid:
          type: string
          description: The ID of the zone the Stickiness policy belongs to
    LdapConfigResult:
      type: object
      properties:
        binddn:
          type: string
          description: Specify the distinguished name of a user with the search permission on the directory
        bindpass:
          type: string
          description: DN password
        hostname:
          type: string
          description: 'Hostname or ip address of the ldap server eg: my.ldap.com'
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        port:
          type: string
          description: Specify the LDAP port if required, default is 389
        queryfilter:
          type: string
          description: You specify a query filter here, which narrows down the users, who can be part of this domain
        searchbase:
          type: string
          description: 'The search base defines the starting point for the search in the directory tree Example:  dc=cloud,dc=com'
        ssl:
          type: string
          description: Check Use SSL if the external LDAP server is configured for LDAP over SSL
    LdapConfiguration:
      type: object
      properties:
        domainid:
          type: string
          description: Linked domain
        hostname:
          type: string
          description: Name of the host running the LDAP server
        id:
          type: string
          description: the ID of the LDAP configuration
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        port:
          type: integer
          format: int32
          description: Port the LDAP server is running on
    LdapUser:
      type: object
      properties:
        conflictingusersource:
          type: string
          description: The authentication source for this user as known to the system or empty if the user is not yet in cloudstack.
        domain:
          type: string
          description: The user's domain
        email:
          type: string
          description: The user's email
        firstname:
          type: string
          description: The user's firstname
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastname:
          type: string
          description: The user's lastname
        principal:
          type: string
          description: The user's principle
        username:
          type: string
          description: The user's username
    LinkAccountToLdapResult:
      type: object
      properties:
        accountid:
          type: string
          description: Domain Admin accountId that is created
        accounttype:
          type: integer
          format: int32
          description: Type of the Account to auto import
        domainid:
          type: string
          description: ID of the Domain which is linked to LDAP
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        ldapdomain:
          type: string
          description: Name of the group or OU in LDAP which is linked to the domain
        name:
          type: string
          description: Name of the group or OU in LDAP which is linked to the domain
        type:
          type: string
          description: Type of the name in LDAP which is linked to the domain
    ListAlertTypesResult:
      type: object
      properties:
        description:
          type: string
          description: Description of the alert
        id:
          type: string
          description: The ID of the alert
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the alert
        sent:
          type: string
          x-cloudstack-type: date
          description: The date and time the alert was sent. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        type:
          type: integer
          format: int32
          description: 'One of the following alert types: MEMORY = 0, CPU = 1, STORAGE = 2, STORAGE_ALLOCATED = 3, PUBLIC_IP = 4, PRIVATE_IP = 5, SECONDARY_STORAGE = 6, HOST = 7, USERVM = 8, DOMAIN_ROUTER = 9, CONSOLE_PROXY = 10, ROUTING = 11: lost connection to default route (to the gateway), STORAGE_MISC = 12, USAGE_SERVER = 13, MANAGMENT_NODE = 14, DOMAIN_ROUTER_MIGRATE = 15, CONSOLE_PROXY_MIGRATE = 16, USERVM_MIGRATE = 17, VLAN = 18, SSVM = 19, USAGE_SERVER_RESULT = 20, STORAGE_DELETE = 21, UPDATE_RESOURCE_COUNT = 22, USAGE_SANITY_RESULT = 23, DIRECT_ATTACHED_PUBLIC_IP = 24, LOCAL_STORAGE = 25, RESOURCE_LIMIT_EXCEEDED = 26, SYNC = 27, UPLOAD_FAILED = 28, OOBM_AUTH_ERROR = 29'
    ListAsyncJobsResult:
      type: object
      properties:
        account:
          type: string
          description: The Account that executed the async command
        accountid:
          type: string
          description: The Account ID that executed the async command
        cmd:
          type: string
          description: The async command executed
        completed:
          type: string
          x-cloudstack-type: date
          description: The completed date of the job. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        created:
          type: string
          x-cloudstack-type: date
          description: The created date of the job. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domainid:
          type: string
          description: The domain ID that executed the async command
        domainpath:
          type: string
          description: The domain that executed the async command
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobinstanceid:
          type: string
          description: The unique ID of the Instance/entity object related to the job
        jobinstancetype:
          type: string
          description: The Instance/entity object related to the job
        jobprocstatus:
          type: integer
          format: int32
          description: The progress information of the PENDING job
        jobresult:
          type: object
          x-cloudstack-type: responseobject
          description: The result reason
        jobresultcode:
          type: integer
          format: int32
          description: The result code for the job
        jobresulttype:
          type: string
          description: The result type
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        managementserverid:
          type: string
          description: The MSID of the management server on which the job is running
        managementservername:
          type: string
          description: the management server name of the host
        userid:
          type: string
          description: The User that executed the async command
    ListBackupProvidersResult:
      type: object
      properties:
        description:
          type: string
          description: The description of the CA service provider
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The CA service provider name
    ListBackupsResult:
      type: object
      properties:
        account:
          type: string
          description: Account name
        accountid:
          type: string
          description: Account id
        backupofferingid:
          type: string
          description: Backup offering id
        backupofferingname:
          type: string
          description: Backup offering name
        compressionstatus:
          type: string
          x-cloudstack-type: compressionstatus
          description: Backup compression status.
        created:
          type: string
          x-cloudstack-type: date
          description: Backup date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: description for the backup
        domain:
          type: string
          description: Domain name
        domainid:
          type: string
          description: Domain ID
        externalid:
          type: string
          description: External backup id
        fromcheckpointid:
          type: string
          description: Previous active checkpoint ID for incremental backups
        hostid:
          type: string
          description: Host ID where the backup is running
        id:
          type: string
          description: ID of the Instance backup
        intervaltype:
          type: string
          description: Interval type of the backup
        isbackupvmexpunged:
          type: boolean
          description: Indicates whether the VM from which the backup was taken is expunged or not
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: name of the backup
        size:
          type: integer
          format: int64
          description: Backup size in bytes
        status:
          type: string
          x-cloudstack-type: status
          description: Backup status
        tocheckpointid:
          type: string
          description: Next checkpoint ID for incremental backups
        type:
          type: string
          description: Backup type
        uncompressedsize:
          type: integer
          format: int64
          description: Backup uncompressed size in bytes. Only defined if backup is compressed.
        validationstatus:
          type: string
          x-cloudstack-type: validationstatus
          description: Backup validation status.
        virtualmachineid:
          type: string
          description: ID of the Instance
        virtualmachinename:
          type: string
          description: Name of the Instance
        virtualsize:
          type: integer
          format: int64
          description: Backup protected (virtual) size in bytes
        vmbackupofferingremoved:
          type: boolean
          description: The backup offering corresponding to this backup was removed from the VM
        vmdetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Lists the vm specific details for the backup
        volumes:
          type: string
          description: Backed up volumes
        zone:
          type: string
          description: Zone name
        zoneid:
          type: string
          description: Zone ID
    ListCniConfigurationResult:
      type: object
      properties:
        account:
          type: string
          description: The owner of the User Data
        accountid:
          type: string
          description: The owner id of the User Data
        domain:
          type: string
          description: The domain name of the User Data owner
        domainid:
          type: string
          description: The domain id of the User Data owner
        domainpath:
          type: string
          description: Path of the domain to which the User Data owner belongs
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: ID of the User Data
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the User Data
        params:
          type: string
          description: List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in the User Data
        project:
          type: string
          description: The project name of the User Data
        projectid:
          type: string
          description: The project id of the User Data
        userdata:
          type: string
          description: Base64 encoded User Data content
    ListDeploymentPlannersResult:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Deployment Planner name
    ListElastistorInterfaceResult:
      type: object
      properties:
        compression:
          type: string
          description: Compression
        deduplication:
          type: string
          description: Deduplication
        graceallowed:
          type: string
          description: graceallowed
        id:
          type: string
          description: The ID of the volume
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the volume
        sync:
          type: string
          description: Synchronization
    ListImageStoreObjectsResult:
      type: object
      properties:
        format:
          type: string
          description: Format of template associated with the data store object.
        isdirectory:
          type: boolean
          description: Is it a directory.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastupdated:
          type: string
          x-cloudstack-type: date
          description: Last modified date of the file/directory. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        name:
          type: string
          description: Name of the data store object.
        size:
          type: integer
          format: int64
          description: Size is in Bytes.
        snapshotid:
          type: string
          description: Snapshot ID associated with the data store object.
        snapshotname:
          type: string
          description: Snapshot Name associated with the data store object.
        templateid:
          type: string
          description: Template ID associated with the data store object.
        templatename:
          type: string
          description: Template Name associated with the data store object.
        volumeid:
          type: string
          description: Volume ID associated with the data store object.
        volumename:
          type: string
          description: Volume Name associated with the data store object.
    ListIsoPermissionsResult:
      type: object
      properties:
        account:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of Accounts the Template is available for
        domainid:
          type: string
          description: The ID of the domain to which the Template belongs
        id:
          type: string
          description: The Template ID
        ispublic:
          type: boolean
          description: True if this Template is a public Template, false otherwise
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        projectids:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of projects the Template is available for
    ListNicsResult:
      type: object
      properties:
        adaptertype:
          type: string
          description: Type of adapter if available
        broadcasturi:
          type: string
          description: The broadcast URI of the NIC
        deviceid:
          type: string
          description: Device ID for the Network when plugged into the Instance
        enabled:
          type: boolean
          description: whether the NIC is enabled or not
        extradhcpoption:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The extra DHCP options on the NIC
        gateway:
          type: string
          description: The gateway of the NIC
        id:
          type: string
          description: The ID of the NIC
        ip6address:
          type: string
          description: The IPv6 address of Network
        ip6cidr:
          type: string
          description: The CIDR of IPv6 Network
        ip6gateway:
          type: string
          description: The gateway of IPv6 Network
        ipaddress:
          type: string
          description: The IP address of the NIC
        ipaddresses:
          type: array
          items: {}
          x-cloudstack-type: list
          description: IP addresses associated with NIC found for unmanaged Instance
        isdefault:
          type: boolean
          description: True if NIC is default, false otherwise
        isolatedpvlan:
          type: integer
          format: int32
          description: The isolated private VLAN if available
        isolatedpvlantype:
          type: string
          description: The isolated private VLAN type if available
        isolationuri:
          type: string
          description: The isolation URI of the NIC
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        macaddress:
          type: string
          description: True if NIC is default, false otherwise
        mtu:
          type: integer
          format: int32
          description: MTU configured on the NIC
        netmask:
          type: string
          description: The netmask of the NIC
        networkid:
          type: string
          description: The ID of the corresponding Network
        networkname:
          type: string
          description: The name of the corresponding Network
        nicdnsname:
          type: string
          description: DNS name associated with this NIC's IP address
        nsxlogicalswitch:
          type: string
          description: Id of the NSX Logical Switch (if NSX based), null otherwise
        nsxlogicalswitchport:
          type: string
          description: Id of the NSX Logical Switch Port (if NSX based), null otherwise
        publicip:
          type: string
          description: Public IP address associated with this NIC via Static NAT rule
        publicipid:
          type: string
          description: Public IP address ID associated with this NIC via Static NAT rule
        secondaryip:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The Secondary IPv4 addr of NIC
        traffictype:
          type: string
          description: The traffic type of the NIC
        type:
          type: string
          description: The type of the NIC
        virtualmachineid:
          type: string
          description: Id of the Instance to which the NIC belongs
        vlanid:
          type: integer
          format: int32
          description: ID of the VLAN/VNI if available
        vpcid:
          type: string
          description: ID of the VPC to which the NIC belongs
        vpcname:
          type: string
          description: Name of the VPC to which the NIC belongs
    ListRegisteredServicePackagesResult:
      type: object
      properties:
        description:
          type: string
          description: Description of Service Package
        id:
          type: string
          description: Service Package UUID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Service Package Name
    ListResourceDetailsResult:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the tag
        customer:
          type: string
          description: Customer associated with the tag
        domain:
          type: string
          description: The domain associated with the tag
        domainid:
          type: string
          description: The ID of the domain associated with the tag
        domainpath:
          type: string
          description: Path of the Domain associated with the tag
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        key:
          type: string
          description: Tag key name
        project:
          type: string
          description: The project name where tag belongs to
        projectid:
          type: string
          description: The project ID the tag belongs to
        resourceid:
          type: string
          description: ID of the resource
        resourcetype:
          type: string
          description: Resource type
        value:
          type: string
          description: Tag value
    ListSystemVmsUsageHistoryResult:
      type: object
      properties:
        displayname:
          type: string
          description: User generated name. The name of the Instance is returned if no displayname exists.
        id:
          type: string
          description: The ID of the Instance
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The Name of the Instance
        stats:
          type: array
          items:
            $ref: '#/components/schemas/Stats'
          x-cloudstack-type: list
          description: The list of Instance stats
    ListUnmanagedInstancesResult:
      type: object
      properties:
        bootmode:
          type: string
          description: indicates the boot mode
        boottype:
          type: string
          description: indicates the boot type
        clusterid:
          type: string
          description: The ID of the cluster to which Instance belongs
        clustername:
          type: string
          description: the name of the cluster to which virtual machine belongs
        cpucorepersocket:
          type: integer
          format: int32
          description: The CPU cores per socket for the Instance. VMware specific
        cpunumber:
          type: integer
          format: int32
          description: The CPU cores of the Instance
        cpuspeed:
          type: integer
          format: int32
          description: The CPU speed of the Instance
        disk:
          type: array
          items:
            $ref: '#/components/schemas/Disk'
          x-cloudstack-type: set
          description: The list of disks associated with the Instance
        hostid:
          type: string
          description: The ID of the host to which Instance belongs
        hostname:
          type: string
          description: The name of the host to which Instance belongs
        hypervisor:
          type: string
          description: The hypervisor to which Instance belongs
        hypervisorversion:
          type: string
          description: The hypervisor version of the host to which Instance belongs
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        memory:
          type: integer
          format: int32
          description: The memory of the Instance in MB
        name:
          type: string
          description: The name of the Instance
        nic:
          type: array
          items:
            $ref: '#/components/schemas/Nic'
          x-cloudstack-type: set
          description: The list of NICs associated with the Instance
        osdisplayname:
          type: string
          description: The operating system of the Instance
        osid:
          type: string
          description: The operating system ID of the Instance
        powerstate:
          type: string
          description: The power state of the Instance
    LoadBalancer:
      type: object
      properties:
        account:
          type: string
          description: The Account of the Load Balancer
        algorithm:
          type: string
          description: The Load balancer algorithm (source, roundrobin, leastconn)
        description:
          type: string
          description: The description of the Load Balancer
        domain:
          type: string
          description: The domain of the Load Balancer
        domainid:
          type: string
          description: The domain ID of the Load Balancer
        domainpath:
          type: string
          description: path of the domain to which the Load Balancer belongs
        fordisplay:
          type: boolean
          description: Is rule for display to the regular User
        id:
          type: string
          description: The Load Balancer ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        loadbalancerinstance:
          type: array
          items:
            $ref: '#/components/schemas/Loadbalancerinstance'
          x-cloudstack-type: list
          description: The list of Instances associated with the Load Balancer
        loadbalancerrule:
          type: array
          items:
            $ref: '#/components/schemas/Loadbalancerrule2'
          x-cloudstack-type: list
          description: The list of rules associated with the Load Balancer
        name:
          type: string
          description: The name of the Load Balancer
        networkid:
          type: string
          description: Load Balancer Network id
        project:
          type: string
          description: The project name of the Load Balancer
        projectid:
          type: string
          description: The project id of the Load Balancer
        sourceipaddress:
          type: string
          description: Load Balancer source IP
        sourceipaddressnetworkid:
          type: string
          description: Load Balancer source IP Network id
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with the Load Balancer
    LoadBalancerRule:
      type: object
      properties:
        account:
          type: string
          description: The Account of the Load balancer rule
        algorithm:
          type: string
          description: The Load balancer algorithm (source, roundrobin, leastconn)
        cidrlist:
          type: string
          description: The CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).
        description:
          type: string
          description: The description of the Load balancer
        domain:
          type: string
          description: The domain of the Load balancer rule
        domainid:
          type: string
          description: The domain ID of the Load balancer rule
        domainpath:
          type: string
          description: path of the domain to which the load balancer rule belongs
        fordisplay:
          type: boolean
          description: Is rule for display to the regular user
        id:
          type: string
          description: The Load balancer rule ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the Load balancer
        networkid:
          type: string
          description: The ID of the guest Network the LB rule belongs to
        privateport:
          type: string
          description: The private port
        project:
          type: string
          description: The project name of the Load balancer
        projectid:
          type: string
          description: The project ID of the Load balancer
        protocol:
          type: string
          description: The protocol of the Load Balancer rule
        publicip:
          type: string
          description: The public IP address
        publicipid:
          type: string
          description: The public IP address ID
        publicport:
          type: string
          description: The public port
        state:
          type: string
          description: The state of the rule
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with Load balancer
        zoneid:
          type: string
          description: The ID of the zone the rule belongs to
        zonename:
          type: string
          description: The name of the zone the Load balancer rule belongs to
    LoadBalancerRuleInstance:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lbvmipaddresses:
          type: array
          items: {}
          x-cloudstack-type: list
          description: IP addresses of the Instance set of LB rule
        loadbalancerruleinstance:
          type: object
          x-cloudstack-type: uservmresponse
          description: The user Instance set for LB rule
    LoadBalancerSslCertificate:
      type: object
      properties:
        chain:
          type: string
          description: chain
        crt:
          type: string
          description: crt
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        key:
          type: string
          description: Key
    Loadbalancerinstance:
      type: object
      properties:
        id:
          type: string
          description: The Instance ID
        ipaddress:
          type: string
          description: The IP address of the Instance
        name:
          type: string
          description: The name of the Instance
        state:
          type: string
          description: The state of the Instance
    Loadbalancerrule:
      type: object
      properties:
        account:
          type: string
          description: The Account of the Load balancer rule
        algorithm:
          type: string
          description: The Load balancer algorithm (source, roundrobin, leastconn)
        cidrlist:
          type: string
          description: The CIDR list to allow traffic, all other CIDRs will be blocked. Multiple entries must be separated by a single comma character (,).
        description:
          type: string
          description: The description of the Load balancer
        domain:
          type: string
          description: The domain of the Load balancer rule
        domainid:
          type: string
          description: The domain ID of the Load balancer rule
        domainpath:
          type: string
          description: path of the domain to which the load balancer rule belongs
        fordisplay:
          type: boolean
          description: Is rule for display to the regular user
        id:
          type: string
          description: The Load balancer rule ID
        name:
          type: string
          description: The name of the Load balancer
        networkid:
          type: string
          description: The ID of the guest Network the LB rule belongs to
        privateport:
          type: string
          description: The private port
        project:
          type: string
          description: The project name of the Load balancer
        projectid:
          type: string
          description: The project ID of the Load balancer
        protocol:
          type: string
          description: The protocol of the Load Balancer rule
        publicip:
          type: string
          description: The public IP address
        publicipid:
          type: string
          description: The public IP address ID
        publicport:
          type: string
          description: The public port
        state:
          type: string
          description: The state of the rule
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with Load balancer
        zoneid:
          type: string
          description: The ID of the zone the rule belongs to
        zonename:
          type: string
          description: The name of the zone the Load balancer rule belongs to
    Loadbalancerrule2:
      type: object
      properties:
        instanceport:
          type: integer
          format: int32
          description: Instance port of the Load balancer rule
        sourceport:
          type: integer
          format: int32
          description: Source port of the Load balancer rule
        state:
          type: string
          description: The state of the Load balancer rule
    LoginResult:
      type: object
      properties:
        account:
          type: string
          description: The Account name the User belongs to
        domainid:
          type: string
          description: Domain ID that the user belongs to
        firstname:
          type: string
          description: First name of the user
        is2faenabled:
          type: string
          description: Is two factor authentication enabled
        is2faverified:
          type: string
          description: Is two factor authentication verified
        issuerfor2fa:
          type: string
          description: Two factor authentication issuer
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastname:
          type: string
          description: Last name of the user
        managementserverid:
          type: string
          description: Management Server ID that the user logged to
        passwordchangerequired:
          type: boolean
          description: Indicates whether the User is required to change password on next login.
        providerfor2fa:
          type: string
          description: Two factor authentication provider
        registered:
          type: string
          description: Is user registered
        sessionkey:
          type: string
          description: Session key that can be passed in subsequent Query command calls
        timeout:
          type: integer
          format: int32
          description: The time period before the session has expired
        timezone:
          type: string
          description: User time zone
        timezoneoffset:
          type: string
          description: User time zoneoffset
        type:
          type: string
          description: The Account type (admin, domain-admin, read-only-admin, user)
        userid:
          type: string
          description: User ID
        username:
          type: string
          description: Username
    Logout:
      type: object
      properties:
        description:
          type: string
          description: Response description
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    ManagementServer:
      type: object
      properties:
        agents:
          type: array
          items: {}
          x-cloudstack-type: list
          description: the agents this Management Server is responsible for
        agentscount:
          type: integer
          format: int64
          description: the number of host agents this Management Server is responsible for
        id:
          type: string
          description: The ID of the management server
        ipaddress:
          type: string
          description: the IP Address for this Management Server
        javadistribution:
          type: string
          description: The java distribution name running the management server process
        javaversion:
          type: string
          description: The version of the java distribution running the management server process
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        kernelversion:
          type: string
          description: The running OS kernel version for this Management Server
        lastagents:
          type: array
          items: {}
          x-cloudstack-type: list
          description: the last agents this Management Server is responsible for, before shutdown or preparing for maintenance
        lastboottime:
          type: string
          x-cloudstack-type: date
          description: The last time the host on which this Management Server runs was booted. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        lastserverstart:
          type: string
          x-cloudstack-type: date
          description: The last time this Management Server was started. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        lastserverstop:
          type: string
          x-cloudstack-type: date
          description: The last time this Management Server was stopped. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        name:
          type: string
          description: The name of the management server
        osdistribution:
          type: string
          description: The name of the OS distribution running on the management server
        peers:
          type: array
          items: {}
          x-cloudstack-type: list
          description: the Management Server Peers
        pendingjobscount:
          type: integer
          format: int64
          description: the number of pending jobs in this Management Server
        serviceip:
          type: string
          description: The IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.
        state:
          type: string
          x-cloudstack-type: state
          description: The state of the management server
        version:
          type: string
          description: The version of the management server
    ManagementServersMetric:
      type: object
      properties:
        agentcount:
          type: integer
          format: int32
          description: The number of agents this Management Server is responsible for
        agents:
          type: array
          items: {}
          x-cloudstack-type: list
          description: the agents this Management Server is responsible for
        agentscount:
          type: integer
          format: int64
          description: the number of host agents this Management Server is responsible for
        availableprocessors:
          type: integer
          format: int32
          description: The number of processors available to the JVM
        collectiontime:
          type: string
          x-cloudstack-type: date
          description: The time these statistics were collected. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        cpuload:
          type: string
          description: The current cpu load
        dbislocal:
          type: boolean
          description: The system is running against a local database
        heapmemorytotal:
          type: integer
          format: int64
          description: The amount of memory allocated to this Management Server
        heapmemoryused:
          type: integer
          format: int64
          description: The amount of memory used by this Management Server
        id:
          type: string
          description: The ID of the management server
        ipaddress:
          type: string
          description: the IP Address for this Management Server
        javadistribution:
          type: string
          description: The java distribution name running the management server process
        javaversion:
          type: string
          description: The version of the java distribution running the management server process
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        kernelversion:
          type: string
          description: The running OS kernel version for this Management Server
        lastagents:
          type: array
          items: {}
          x-cloudstack-type: list
          description: the last agents this Management Server is responsible for, before shutdown or preparing for maintenance
        lastboottime:
          type: string
          x-cloudstack-type: date
          description: The last time the host on which this Management Server runs was booted. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        lastserverstart:
          type: string
          x-cloudstack-type: date
          description: The last time this Management Server was started. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        lastserverstop:
          type: string
          x-cloudstack-type: date
          description: The last time this Management Server was stopped. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        loginfo:
          type: string
          description: The log files and their usage on disk
        name:
          type: string
          description: The name of the management server
        osdistribution:
          type: string
          description: The name of the OS distribution running on the management server
        peers:
          type: array
          items: {}
          x-cloudstack-type: list
          description: the Management Server Peers
        pendingjobscount:
          type: integer
          format: int64
          description: the number of pending jobs in this Management Server
        serviceip:
          type: string
          description: The IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.
        sessions:
          type: integer
          format: int64
          description: The number of client sessions active on this Management Server
        state:
          type: string
          x-cloudstack-type: state
          description: The state of the management server
        systemcycleusage:
          type: array
          items:
            type: integer
            format: int64
          description: The system load for user, and system processes and the system idle cycles
        systemloadaverages:
          type: array
          items:
            type: number
            format: double
          description: The load averages for 1 5 and 15 minutes
        systemmemoryfree:
          type: string
          description: Free system memory
        systemmemorytotal:
          type: string
          description: Total system memory
        systemmemoryused:
          type: string
          description: Amount of memory used
        systemmemoryvirtualsize:
          type: string
          description: Virtual size of the fully loaded process
        systemtotalcpucycles:
          type: number
          format: double
          description: The total system cpu capacity
        threadsblockedcount:
          type: integer
          format: int32
          description: The number of blocked threads
        threadsdaemoncount:
          type: integer
          format: int32
          description: The number of daemon threads
        threadsrunnablecount:
          type: integer
          format: int32
          description: The number of runnable threads
        threadsteminatedcount:
          type: integer
          format: int32
          description: The number of terminated threads
        threadstotalcount:
          type: integer
          format: int32
          description: The number of threads
        threadswaitingcount:
          type: integer
          format: int32
          description: The number of waiting threads
        usageislocal:
          type: boolean
          description: The system has a usage server running locally
        version:
          type: string
          description: The version of the management server
    MigrateResourceToAnotherSecondaryStorageResult:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        message:
          type: string
          description: Response message from migration of secondary storage data objects
        migrationtype:
          type: string
          description: Type of migration requested for
        success:
          type: boolean
          description: True if operation is executed successfully
    NetscalerControlCenter:
      type: object
      properties:
        id:
          type: string
          description: ID
        ipaddress:
          type: string
          description: ncc_ip
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        numretries:
          type: string
          description: Number of retries
        username:
          type: string
          description: Username
        uuid:
          type: string
          description: UUID
    NetscalerLoadBalancer:
      type: object
      properties:
        gslbprovider:
          type: boolean
          description: True if NetScaler device is provisioned to be a GSLB service provider
        gslbproviderprivateip:
          type: string
          description: Private IP of the NetScaler representing GSLB site
        gslbproviderpublicip:
          type: string
          description: Public IP of the NetScaler representing GSLB site
        ipaddress:
          type: string
          description: The management IP address of the external load balancer
        isexclusivegslbprovider:
          type: boolean
          description: True if NetScaler device is provisioned exclusively to be a GSLB service provider
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lbdevicecapacity:
          type: integer
          format: int64
          description: Device capacity
        lbdevicededicated:
          type: boolean
          description: True if device is dedicated for an account
        lbdeviceid:
          type: string
          description: Device ID of the netscaler load balancer
        lbdevicename:
          type: string
          description: Device name
        lbdevicestate:
          type: string
          description: Device state
        physicalnetworkid:
          type: string
          description: The physical Network to which this netscaler device belongs to
        podids:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Used when NetScaler device is provider of EIP service. This parameter represents the list of pod's, for which there exists a policy based route on datacenter L3 router to route pod's subnet IP to a NetScaler device.
        privateinterface:
          type: string
          description: The private interface of the load balancer
        provider:
          type: string
          description: Name of the provider
        publicinterface:
          type: string
          description: The public interface of the load balancer
    Network:
      type: object
      properties:
        account:
          type: string
          description: The owner of the Network
        aclid:
          type: string
          description: ACL ID associated with the VPC Network
        aclname:
          type: string
          description: ACL name associated with the VPC Network
        acltype:
          type: string
          description: ACL type - access type to the Network
        asnumber:
          type: integer
          format: int64
          description: AS NUMBER
        asnumberid:
          type: string
          description: UUID of AS NUMBER
        associatednetwork:
          type: string
          description: The name of the Network associated with this private gateway
        associatednetworkid:
          type: string
          description: The ID of the Network associated with this private gateway
        bgppeers:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The BGP peers for the network
        broadcastdomaintype:
          type: string
          description: Broadcast domain type of the Network
        broadcasturi:
          type: string
          description: Broadcast URI of the Network. This parameter is visible to ROOT admins only
        canusefordeploy:
          type: boolean
          description: List Networks available for Instance deployment
        cidr:
          type: string
          description: CloudStack managed address space, all CloudStack managed Instances get IP address from CIDR
        created:
          type: string
          x-cloudstack-type: date
          description: The date this Network was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: The details of the Network
        displaynetwork:
          type: boolean
          description: An optional field, whether to the display the Network to the end user or not.
        displaytext:
          type: string
          description: The displaytext of the Network
        dns1:
          type: string
          description: The first IPv4 DNS for the Network
        dns2:
          type: string
          description: The second IPv4 DNS for the Network
        dnssubdomain:
          type: string
          description: DNS subdomain associated to the network
        dnszone:
          type: string
          description: DNS zone associated to the network
        domain:
          type: string
          description: The domain name of the Network owner
        domainid:
          type: string
          description: The domain ID of the Network owner
        domainpath:
          type: string
          description: Path of the Domain the network belongs to
        egressdefaultpolicy:
          type: boolean
          description: True if guest Network default egress policy is allow; false if default egress policy is deny
        externalid:
          type: string
          description: The external ID of the Network
        gateway:
          type: string
          description: The Network's gateway
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The ID of the Network
        internetprotocol:
          type: string
          description: The internet protocol of Network offering
        ip4routes:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The routes for the network to ease adding route in upstream router
        ip4routing:
          type: string
          description: The IPv4 routing type of network
        ip6cidr:
          type: string
          description: The CIDR of IPv6 Network
        ip6dns1:
          type: string
          description: The first IPv6 DNS for the network
        ip6dns2:
          type: string
          description: The second IPv6 DNS for the network
        ip6gateway:
          type: string
          description: The gateway of IPv6 Network
        ip6routes:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The routes for the Network to ease adding route in upstream router
        ip6routing:
          type: string
          description: The IPv6 routing type of network offering
        isdefault:
          type: boolean
          description: True if Network is default, false otherwise
        ispersistent:
          type: boolean
          description: List Networks that are persistent
        issystem:
          type: boolean
          description: True if Network is system, false otherwise
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        keepmacaddressonpublicnic:
          type: boolean
          description: Indicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have  a new MAC address.
        name:
          type: string
          description: The name of the Network
        netmask:
          type: string
          description: The Network's netmask
        networkcidr:
          type: string
          description: The Network CIDR of the guest Network configured with IP reservation. It is the summation of CIDR and RESERVED_IP_RANGE
        networkdomain:
          type: string
          description: The Network domain
        networkofferingavailability:
          type: string
          description: Availability of the Network offering the Network is created from
        networkofferingconservemode:
          type: boolean
          description: True if Network offering is IP conserve mode enabled
        networkofferingdisplaytext:
          type: string
          description: Display text of the Network offering the Network is created from
        networkofferingid:
          type: string
          description: Network offering ID the Network is created from
        networkofferingname:
          type: string
          description: Name of the Network offering the Network is created from
        physicalnetworkid:
          type: string
          description: The physical Network id
        privatemtu:
          type: integer
          format: int32
          description: MTU configured on the network VR's private interfaces
        project:
          type: string
          description: The project name of the address
        projectid:
          type: string
          description: The project ID of the IP address
        publicmtu:
          type: integer
          format: int32
          description: MTU configured on the Network VR's public facing interfaces
        receivedbytes:
          type: integer
          format: int64
          description: The total number of Network traffic bytes received
        redundantrouter:
          type: boolean
          description: If the Network has redundant routers enabled
        related:
          type: string
          description: Related to what other Network configuration
        reservediprange:
          type: string
          description: The Network's IP range not to be used by CloudStack guest Instances and can be used for non CloudStack purposes
        restartrequired:
          type: boolean
          description: True if Network requires restart
        sentbytes:
          type: integer
          format: int64
          description: The total number of Network traffic bytes sent
        service:
          type: array
          items:
            $ref: '#/components/schemas/Service'
          x-cloudstack-type: list
          description: The list of services
        specifyipranges:
          type: boolean
          description: True if Network supports specifying IP ranges, false otherwise
        specifyvlan:
          type: boolean
          description: True if network supports specifying vlan, false otherwise
        state:
          type: string
          description: State of the Network
        strechedl2subnet:
          type: boolean
          description: True if Network can span multiple zones
        subdomainaccess:
          type: boolean
          description: True if users from subdomains can access the domain level Network
        supportsvmautoscaling:
          type: boolean
          description: If Network offering supports Instance autoscaling feature
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with Network
        traffictype:
          type: string
          description: The traffic type of the Network
        tungstenvirtualrouteruuid:
          type: string
          description: Tungsten-Fabric virtual router the Network belongs to
        type:
          type: string
          description: The type of the Network
        vlan:
          type: string
          description: The VLAN of the Network. This parameter is visible to ROOT admins only
        vpcid:
          type: string
          description: VPC the Network belongs to
        vpcname:
          type: string
          description: Name of the VPC to which this Network belongs
        zoneid:
          type: string
          description: Zone ID of the Network
        zonename:
          type: string
          description: The name of the zone the Network belongs to
        zonesnetworkspans:
          type: array
          items: {}
          x-cloudstack-type: set
          description: If a Network is enabled for 'stretched L2 subnet' then represents zones on which Network currently spans
    NetworkACL:
      type: object
      properties:
        aclid:
          type: string
          description: The ID of the ACL this item belongs to
        aclname:
          type: string
          description: The name of the ACL this item belongs to
        action:
          type: string
          description: Action of ACL Item. Allow/Deny
        cidrlist:
          type: string
          description: The CIDR list to forward traffic from. Multiple entries are separated by a single comma character (,).
        endport:
          type: string
          description: The ending port of ACL's port range
        fordisplay:
          type: boolean
          description: Is rule for display to the regular user
        icmpcode:
          type: integer
          format: int32
          description: Error code for this icmp message
        icmptype:
          type: integer
          format: int32
          description: Type of the icmp message being sent
        id:
          type: string
          description: The ID of the ACL Item
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        number:
          type: integer
          format: int32
          description: Number of the ACL Item
        protocol:
          type: string
          description: The protocol of the ACL
        reason:
          type: string
          description: An explanation on why this ACL rule is being applied
        startport:
          type: string
          description: The starting port of ACL's port range
        state:
          type: string
          description: The state of the rule
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with the Network ACLs
        traffictype:
          type: string
          description: The traffic type for the ACL
    NetworkACLList:
      type: object
      properties:
        description:
          type: string
          description: Description of the ACL
        fordisplay:
          type: boolean
          description: Is ACL for display to the regular user
        id:
          type: string
          description: The ID of the ACL
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The Name of the ACL
        vpcid:
          type: string
          description: Id of the VPC this ACL is associated with
        vpcname:
          type: string
          description: Name of the VPC this ACL is associated with
    NetworkDevice:
      type: object
      properties:
        id:
          type: string
          description: The ID of the Network device
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    NetworkOffering:
      type: object
      properties:
        availability:
          type: string
          description: Availability of the Network offering
        conservemode:
          type: boolean
          description: True if Network offering is IP conserve mode enabled
        created:
          type: string
          x-cloudstack-type: date
          description: The date this Network offering was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Additional key/value details tied with network offering
        displaytext:
          type: string
          description: An alternate display text of the Network offering.
        domain:
          type: string
          description: The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        domainid:
          type: string
          description: The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        egressdefaultpolicy:
          type: boolean
          description: True if guest network default egress policy is allow; false if default egress policy is deny
        fornsx:
          type: boolean
          description: true if network offering can be used by NSX networks only
        fortungsten:
          type: boolean
          description: True if Network offering can be used by Tungsten-Fabric Networks only
        forvpc:
          type: boolean
          description: True if Network offering can be used by VPC Networks only
        guestiptype:
          type: string
          description: Guest type of the Network offering, can be Shared or Isolated
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The ID of the Network offering
        internetprotocol:
          type: string
          description: The internet protocol of the network offering
        isdefault:
          type: boolean
          description: True if Network offering is default, false otherwise
        ispersistent:
          type: boolean
          description: True if Network offering supports persistent networks, false otherwise
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        maxconnections:
          type: integer
          format: int32
          description: Maximum number of concurrent connections to be handled by LB
        name:
          type: string
          description: The name of the Network offering
        networkmode:
          type: string
          description: Mode in which the network will operate. The valid values are NATTED and ROUTED
        networkrate:
          type: integer
          format: int32
          description: Data transfer rate in megabits per second allowed.
        routingmode:
          type: string
          description: the routing mode for the network offering, supported types are Static or Dynamic.
        service:
          type: array
          items:
            $ref: '#/components/schemas/Service'
          x-cloudstack-type: list
          description: The list of supported services
        serviceofferingid:
          type: string
          description: The ID of the service offering used by virtual router provider
        specifyasnumber:
          type: boolean
          description: true if network offering supports choosing AS numbers
        specifyipranges:
          type: boolean
          description: True if Network offering supports specifying IP ranges, false otherwise
        specifyvlan:
          type: boolean
          description: True if Network offering supports VLANs, false otherwise
        state:
          type: string
          description: State of the Network offering. Can be Disabled/Enabled/Inactive
        supportsinternallb:
          type: boolean
          description: true if network offering supports public access for guest networks
        supportspublicaccess:
          type: boolean
          description: True if network offering supports public access for guest networks
        supportsstrechedl2subnet:
          type: boolean
          description: True if network offering supports network that span multiple zones
        tags:
          type: string
          description: The tags for the Network offering
        traffictype:
          type: string
          description: The traffic type for the Network offering, supported types are Public, Management, Control, Guest, VLAN or Storage.
        zone:
          type: string
          description: The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        zoneid:
          type: string
          description: The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
    NetworkPermission:
      type: object
      properties:
        account:
          type: string
          description: The Account the Network is available for
        accountid:
          type: string
          description: The ID of Account the Network is available for
        domain:
          type: string
          description: The name of the domain to which the Network belongs
        domainid:
          type: string
          description: The ID of the domain to which the Network belongs
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        networkid:
          type: string
          description: The Network ID
        project:
          type: string
          description: The project the Network is available for
        projectid:
          type: string
          description: The ID of project the Network is available for
    NetworkProtocol:
      type: object
      properties:
        description:
          type: string
          description: the description of the protocol parameter
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: the details of the protocol parameter
        index:
          type: integer
          format: int32
          description: the index (ID, Value, Code, Type, Option, etc) of the protocol parameter
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: the name of the protocol parameter
    NetworkServiceProvider:
      type: object
      properties:
        canenableindividualservice:
          type: boolean
          description: True if individual services can be enabled/disabled
        destinationphysicalnetworkid:
          type: string
          description: The destination physical Network
        id:
          type: string
          description: UUID of the Network provider
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The provider name
        physicalnetworkid:
          type: string
          description: The physical Network this belongs to
        servicelist:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Services for this provider
        state:
          type: string
          description: State of the Network provider
    Nic:
      type: object
      properties:
        adaptertype:
          type: string
          description: Type of adapter if available
        broadcasturi:
          type: string
          description: The broadcast URI of the NIC
        deviceid:
          type: string
          description: Device ID for the Network when plugged into the Instance
        enabled:
          type: boolean
          description: whether the NIC is enabled or not
        extradhcpoption:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The extra DHCP options on the NIC
        gateway:
          type: string
          description: The gateway of the NIC
        id:
          type: string
          description: The ID of the NIC
        ip6address:
          type: string
          description: The IPv6 address of Network
        ip6cidr:
          type: string
          description: The CIDR of IPv6 Network
        ip6gateway:
          type: string
          description: The gateway of IPv6 Network
        ipaddress:
          type: string
          description: The IP address of the NIC
        ipaddresses:
          type: array
          items: {}
          x-cloudstack-type: list
          description: IP addresses associated with NIC found for unmanaged Instance
        isdefault:
          type: boolean
          description: True if NIC is default, false otherwise
        isolatedpvlan:
          type: integer
          format: int32
          description: The isolated private VLAN if available
        isolatedpvlantype:
          type: string
          description: The isolated private VLAN type if available
        isolationuri:
          type: string
          description: The isolation URI of the NIC
        macaddress:
          type: string
          description: True if NIC is default, false otherwise
        mtu:
          type: integer
          format: int32
          description: MTU configured on the NIC
        netmask:
          type: string
          description: The netmask of the NIC
        networkid:
          type: string
          description: The ID of the corresponding Network
        networkname:
          type: string
          description: The name of the corresponding Network
        nicdnsname:
          type: string
          description: DNS name associated with this NIC's IP address
        nsxlogicalswitch:
          type: string
          description: Id of the NSX Logical Switch (if NSX based), null otherwise
        nsxlogicalswitchport:
          type: string
          description: Id of the NSX Logical Switch Port (if NSX based), null otherwise
        publicip:
          type: string
          description: Public IP address associated with this NIC via Static NAT rule
        publicipid:
          type: string
          description: Public IP address ID associated with this NIC via Static NAT rule
        secondaryip:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The Secondary IPv4 addr of NIC
        traffictype:
          type: string
          description: The traffic type of the NIC
        type:
          type: string
          description: The type of the NIC
        virtualmachineid:
          type: string
          description: Id of the Instance to which the NIC belongs
        vlanid:
          type: integer
          format: int32
          description: ID of the VLAN/VNI if available
        vpcid:
          type: string
          description: ID of the VPC to which the NIC belongs
        vpcname:
          type: string
          description: Name of the VPC to which the NIC belongs
    NiciraNvpDevice:
      type: object
      properties:
        hostname:
          type: string
          description: The controller IP address
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        l2gatewayserviceuuid:
          type: string
          description: This L2 gateway service UUID
        l3gatewayserviceuuid:
          type: string
          description: This L3 gateway service UUID
        niciradevicename:
          type: string
          description: Device name
        nvpdeviceid:
          type: string
          description: Device ID of the Nicire Nvp
        physicalnetworkid:
          type: string
          description: The physical Network to which this Nirica Nvp belongs to
        provider:
          type: string
          description: Name of the provider
        transportzoneuuid:
          type: string
          description: The transport zone UUID
    OauthProvider:
      type: object
      properties:
        authorizeurl:
          type: string
          description: Authorize URL registered in the OAuth provider
        clientid:
          type: string
          description: Client ID registered in the OAuth provider
        description:
          type: string
          description: Description of the provider registered
        domain:
          type: string
          description: name of the domain the provider belongs to (empty for global)
        domainid:
          type: string
          description: UUID of the domain the provider belongs to (empty for global)
        domainpath:
          type: string
          description: path of the domain the provider belongs to (empty for global)
        enabled:
          type: boolean
          description: Whether the OAuth provider is enabled or not
        id:
          type: string
          description: ID of the provider
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the provider
        provider:
          type: string
          description: Name of the provider
        redirecturi:
          type: string
          description: Redirect URI registered in the OAuth provider
        secretkey:
          type: string
          description: Secret key registered in the OAuth provider
        tokenurl:
          type: string
          description: Token URL registered in the OAuth provider
    ObjectStoragePool:
      type: object
      properties:
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: the ID of the object store
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: the name of the object store
        providername:
          type: string
          description: the provider name of the object store
        storageallocated:
          type: integer
          format: int64
          description: the allocated size of the object store
        storagetotal:
          type: integer
          format: int64
          description: the total size of the object store
        storageused:
          type: integer
          format: int64
          description: the object store currently used size
        url:
          type: string
          description: the url of the object store
    OpenDaylightController:
      type: object
      properties:
        id:
          type: string
          description: Device ID of the controller
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name assigned to the controller
        physicalnetworkid:
          type: string
          description: The physical Network to which this controller belongs to
        url:
          type: string
          description: The URL of the controller API
        username:
          type: string
          description: The username to authenticate to the controller
    OsCategory:
      type: object
      properties:
        created:
          type: string
          x-cloudstack-type: date
          description: Date when the OS category was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The ID of the OS category
        isfeatured:
          type: boolean
          description: Whether the OS category is featured
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the OS category
    PaloAltoFirewall:
      type: object
      properties:
        fwdevicecapacity:
          type: integer
          format: int64
          description: Device capacity
        fwdeviceid:
          type: string
          description: Device ID of the Palo Alto firewall
        fwdevicename:
          type: string
          description: Device name
        fwdevicestate:
          type: string
          description: Device state
        ipaddress:
          type: string
          description: The management IP address of the external firewall
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        numretries:
          type: string
          description: The number of times to retry requests to the external firewall
        physicalnetworkid:
          type: string
          description: The physical Network to which this Palo Alto firewall belongs to
        privateinterface:
          type: string
          description: The private interface of the external firewall
        privatezone:
          type: string
          description: The private security zone of the external firewall
        provider:
          type: string
          description: Name of the provider
        publicinterface:
          type: string
          description: The public interface of the external firewall
        publiczone:
          type: string
          description: The public security zone of the external firewall
        timeout:
          type: string
          description: The timeout (in seconds) for requests to the external firewall
        usageinterface:
          type: string
          description: The usage interface of the external firewall
        username:
          type: string
          description: The username that's used to log in to the external firewall
        zoneid:
          type: string
          description: The zone ID of the external firewall
    Parameters:
      type: object
      properties:
        name:
          type: string
          description: Name of the parameter
        required:
          type: boolean
          description: Whether the parameter is required or not
        type:
          type: string
          description: Type of the parameter
        validationformat:
          type: string
          description: Validation format for value of the parameter. Available for specific types
        valueoptions:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Comma-separated list of options for value of the parameter
    Params:
      type: object
      properties:
        description:
          type: string
          description: Description of the API parameter
        length:
          type: integer
          format: int32
          description: Length of the parameter
        name:
          type: string
          description: The name of the API parameter
        related:
          type: string
          description: Comma separated related APIs to get the parameter
        required:
          type: boolean
          description: True if this parameter is required for the API request
        since:
          type: string
          description: Version of CloudStack the API was introduced in
        type:
          type: string
          description: Parameter type
    PathForVolume:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        path:
          type: string
          description: The path field for the volume
    PhysicalNetwork:
      type: object
      properties:
        broadcastdomainrange:
          type: string
          description: Broadcast domain range of the physical Network
        domainid:
          type: string
          description: The domain ID of the physical Network owner
        id:
          type: string
          description: The UUID of the physical Network
        isolationmethods:
          type: string
          description: Isolation methods
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the physical Network
        networkspeed:
          type: string
          description: The speed of the physical Network
        state:
          type: string
          description: State of the physical Network
        tags:
          type: string
          description: Comma separated tag
        vlan:
          type: string
          description: The VLAN of the physical Network
        zoneid:
          type: string
          description: Zone ID of the physical Network
        zonename:
          type: string
          description: Zone name of the physical Network
    Pod:
      type: object
      properties:
        allocationstate:
          type: string
          description: The allocation state of the Pod
        capacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          x-cloudstack-type: list
          description: The capacity of the Pod
        endip:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.
        forsystemvms:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Indicates if range is dedicated for CPVM and SSVM. This parameter is deprecated, please use 'forsystemvms' from ipranges parameter.
        gateway:
          type: string
          description: The gateway of the Pod
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The ID of the Pod
        ipranges:
          type: array
          items:
            $ref: '#/components/schemas/Ipranges'
          x-cloudstack-type: list
          description: The IP ranges for the Pod
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the Pod
        netmask:
          type: string
          description: The netmask of the Pod
        startip:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.
        storageaccessgroups:
          type: string
          description: comma-separated list of storage access groups for the pod
        vlanid:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Indicates VLAN ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.
        zoneid:
          type: string
          description: The Zone ID of the Pod
        zonename:
          type: string
          description: The Zone name of the Pod
        zonestorageaccessgroups:
          type: string
          description: comma-separated list of storage access groups on the zone
    PortableIpRange:
      type: object
      properties:
        endip:
          type: string
          description: The end IP of the portable IP range
        gateway:
          type: string
          description: The gateway of the VLAN IP range
        id:
          type: string
          description: Portable IP range ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        netmask:
          type: string
          description: The netmask of the VLAN IP range
        portableipaddress:
          type: array
          items:
            $ref: '#/components/schemas/Portableipaddress'
          x-cloudstack-type: list
          description: List of portable IP and association with zone/network/vpc details that are part of GSLB rule
        regionid:
          type: integer
          format: int32
          description: Region ID in which portable IP range is provisioned
        startip:
          type: string
          description: The start IP of the portable IP range
        vlan:
          type: string
          description: The ID or VID of the VLAN.
    Portableipaddress:
      type: object
      properties:
        accountid:
          type: string
          description: The Account ID the portable IP address is associated with
        allocated:
          type: string
          x-cloudstack-type: date
          description: Date the portal IP address was acquired. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domainid:
          type: string
          description: The domain ID the portable IP address is associated with
        ipaddress:
          type: string
          description: Public IP address
        networkid:
          type: string
          description: The ID of the Network where IP belongs to
        physicalnetworkid:
          type: string
          description: The physical Network this belongs to
        regionid:
          type: integer
          format: int32
          description: Region ID in which global Load balancer is created
        state:
          type: string
          description: 'State of the IP address. Can be: Allocating, Allocated, Releasing and Free'
        vpcid:
          type: string
          description: VPC the IP belongs to
        zoneid:
          type: string
          description: The ID of the zone the public IP address belongs to
    PrivateGateway:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the private gateway
        aclid:
          type: string
          description: ACL ID set for private gateway
        aclname:
          type: string
          description: ACL name set for private gateway
        associatednetwork:
          type: string
          description: The name of the Network associated with this private gateway
        associatednetworkid:
          type: string
          description: The ID of the Network associated with this private gateway
        domain:
          type: string
          description: The domain associated with the private gateway
        domainid:
          type: string
          description: The ID of the domain associated with the private gateway
        domainpath:
          type: string
          description: Path of the domain to which the private gateway belongs
        gateway:
          type: string
          description: The gateway
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The ID of the private gateway
        ipaddress:
          type: string
          description: The private gateway's IP address
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        netmask:
          type: string
          description: The private gateway's netmask
        physicalnetworkid:
          type: string
          description: The physical Network id
        project:
          type: string
          description: The project name of the private gateway
        projectid:
          type: string
          description: The project ID of the private gateway
        sourcenatsupported:
          type: boolean
          description: Source Nat enable status
        state:
          type: string
          description: State of the gateway, can be Creating, Ready, Deleting
        vlan:
          type: string
          description: The Network implementation uri for the private gateway
        vpcid:
          type: string
          description: VPC ID the private gateway belongs to
        vpcname:
          type: string
          description: VPC name the private gateway belongs to
        zoneid:
          type: string
          description: Zone ID of the private gateway
        zonename:
          type: string
          description: The name of the zone the private gateway belongs to
    Project:
      type: object
      properties:
        backupavailable:
          type: string
          description: the total number of backups available to this project
        backuplimit:
          type: string
          description: the total number of backups which can be stored by this project
        backupstorageavailable:
          type: string
          description: the total backup storage space (in GiB) available to the project
        backupstoragelimit:
          type: string
          description: the total backup storage space (in GiB) the project can own
        backupstoragetotal:
          type: integer
          format: int64
          description: the total backup storage space (in GiB) owned by the project
        backuptotal:
          type: integer
          format: int64
          description: the total number of backups stored by this project
        bucketavailable:
          type: string
          description: the total number of buckets available to this project
        bucketlimit:
          type: string
          description: the total number of buckets which can be stored by this project
        buckettotal:
          type: integer
          format: int64
          description: the total number of buckets stored by this project
        cpuavailable:
          type: string
          description: The total number of CPU cores available to be created for this project
        cpulimit:
          type: string
          description: The total number of CPU cores the project can own
        cputotal:
          type: integer
          format: int64
          description: The total number of CPU cores owned by project
        created:
          type: string
          x-cloudstack-type: date
          description: The date this project was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        displaytext:
          type: string
          description: The displaytext of the project
        domain:
          type: string
          description: The domain name where the project belongs to
        domainid:
          type: string
          description: The domain ID the project belongs to
        gpuavailable:
          type: string
          description: the total number of gpus available to be created for this project
        gpulimit:
          type: string
          description: the total number of gpus the project can own
        gputotal:
          type: integer
          format: int64
          description: the total number of gpus owned by project
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The ID of the project
        ipavailable:
          type: string
          description: The total number of public IP addresses available for this project to acquire
        iplimit:
          type: string
          description: The total number of public IP addresses this project can acquire
        iptotal:
          type: integer
          format: int64
          description: The total number of public IP addresses allocated for this project
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        memoryavailable:
          type: string
          description: The total memory (in MB) available to be created for this project
        memorylimit:
          type: string
          description: The total memory (in MB) the project can own
        memorytotal:
          type: integer
          format: int64
          description: The total memory (in MB) owned by project
        name:
          type: string
          description: The name of the project
        networkavailable:
          type: string
          description: The total number of Networks available to be created for this project
        networklimit:
          type: string
          description: The total number of Networks the project can own
        networktotal:
          type: integer
          format: int64
          description: The total number of Networks owned by project
        objectstorageavailable:
          type: string
          description: the total object storage space (in GiB) available to the project
        objectstoragelimit:
          type: string
          description: the total object storage space (in GiB) the project can own
        objectstoragetotal:
          type: integer
          format: int64
          description: the total object storage space (in GiB) owned by the project
        owner:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The Account name of the project's owners
        primarystorageavailable:
          type: string
          description: The total primary storage space (in GiB) available to be used for this project
        primarystoragelimit:
          type: string
          description: The total primary storage space (in GiB) the project can own
        primarystoragetotal:
          type: integer
          format: int64
          description: The total primary storage space (in GiB) owned by project
        projectaccountname:
          type: string
          description: The project Account name of the project
        secondarystorageavailable:
          type: string
          description: The total secondary storage space (in GiB) available to be used for this project
        secondarystoragelimit:
          type: string
          description: The total secondary storage space (in GiB) the project can own
        secondarystoragetotal:
          type: number
          format: float
          description: The total secondary storage space (in GiB) owned by project
        snapshotavailable:
          type: string
          description: The total number of Snapshots available for this project
        snapshotlimit:
          type: string
          description: The total number of Snapshots which can be stored by this project
        snapshottotal:
          type: integer
          format: int64
          description: The total number of Snapshots stored by this project
        state:
          type: string
          description: The state of the project
        taggedresources:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The tagged resource limit and count for the project
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with Instance
        templateavailable:
          type: string
          description: The total number of Templates available to be created by this project
        templatelimit:
          type: string
          description: The total number of Templates which can be created by this project
        templatetotal:
          type: integer
          format: int64
          description: The total number of Templates which have been created by this project
        vmavailable:
          type: string
          description: The total number of Instances available for this project to acquire
        vmlimit:
          type: string
          description: The total number of Instances that can be deployed by this project
        vmrunning:
          type: integer
          format: int32
          description: The total number of Instances running for this project
        vmstopped:
          type: integer
          format: int32
          description: The total number of Instances stopped for this project
        vmtotal:
          type: integer
          format: int64
          description: The total number of Instances deployed by this project
        volumeavailable:
          type: string
          description: The total volume available for this project
        volumelimit:
          type: string
          description: The total volume which can be used by this project
        volumetotal:
          type: integer
          format: int64
          description: The total volume being used by this project
        vpcavailable:
          type: string
          description: The total number of VPCs available to be created for this project
        vpclimit:
          type: string
          description: The total number of VPCs the project can own
        vpctotal:
          type: integer
          format: int64
          description: The total number of VPCs owned by project
    ProjectInvitation:
      type: object
      properties:
        account:
          type: string
          description: The Account name of the project's owner
        domain:
          type: string
          description: The domain name where the project belongs to
        domainid:
          type: string
          description: The domain ID the project belongs to
        domainpath:
          type: string
          description: Path of the Domain the project belongs to
        email:
          type: string
          description: The email the invitation was sent to
        id:
          type: string
          description: The ID of the invitation
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        project:
          type: string
          description: The name of the project
        projectid:
          type: string
          description: The ID of the project
        state:
          type: string
          description: The invitation state
        userid:
          type: string
          description: The User ID
    ProjectRole:
      type: object
      properties:
        description:
          type: string
          description: The description of the role
        id:
          type: string
          description: The ID of the role
        ispublic:
          type: boolean
          description: Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the role
        projectid:
          type: string
          description: The ID of the project
    ProjectRolePermission:
      type: object
      properties:
        description:
          type: string
          description: The description of the role permission
        id:
          type: string
          description: The ID of the project role permission
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        permission:
          type: string
          description: The permission type of the api name or wildcard rule, allow/deny
        projectid:
          type: string
          description: The ID of the project
        projectroleid:
          type: string
          description: The ID of the project role to which the role permission belongs
        projectrolename:
          type: string
          description: The name of the project role to which the role permission belongs
        rule:
          type: string
          description: The api name or wildcard rule
    Provider:
      type: object
      properties:
        canenableindividualservice:
          type: boolean
          description: True if individual services can be enabled/disabled
        destinationphysicalnetworkid:
          type: string
          description: The destination physical Network
        id:
          type: string
          description: UUID of the Network provider
        name:
          type: string
          description: The provider name
        physicalnetworkid:
          type: string
          description: The physical Network this belongs to
        servicelist:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Services for this provider
        state:
          type: string
          description: State of the Network provider
    QuarantinedIp:
      type: object
      properties:
        created:
          type: string
          x-cloudstack-type: date
          description: When the quarantine was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        enddate:
          type: string
          x-cloudstack-type: date
          description: End date for the quarantine. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        id:
          type: string
          description: ID of the quarantine process.
        ipaddress:
          type: string
          description: The public IP address in quarantine.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        previousownerid:
          type: string
          description: Account ID of the previous public IP address owner.
        previousownername:
          type: string
          description: Account name of the previous public IP address owner.
        removalreason:
          type: string
          description: The reason for removing the IP from quarantine prematurely.
        removed:
          type: string
          x-cloudstack-type: date
          description: When the quarantine was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        removeraccountid:
          type: string
          description: ID of the account that removed the IP from quarantine.
    QuotaIsEnabled:
      type: object
      properties:
        isenabled:
          type: boolean
          description: Is quota service enabled
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    Region:
      type: object
      properties:
        endpoint:
          type: string
          description: The end point of the region
        gslbserviceenabled:
          type: boolean
          description: True if GSLB service is enabled in the region, false otherwise
        id:
          type: integer
          format: int32
          description: The ID of the region
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the region
        portableipserviceenabled:
          type: boolean
          description: True if security groups support is enabled, false otherwise
    RemoteAccessVpn:
      type: object
      properties:
        account:
          type: string
          description: The Account of the remote access VPN
        domain:
          type: string
          description: The domain name of the Account of the remote access VPN
        domainid:
          type: string
          description: The domain ID of the Account of the remote access VPN
        domainpath:
          type: string
          description: Path of the domain to which the remote access VPN belongs
        fordisplay:
          type: boolean
          description: Is VPN for display to the regular user
        id:
          type: string
          description: The ID of the remote access VPN
        iprange:
          type: string
          description: The range of IPs to allocate to the clients
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        presharedkey:
          type: string
          description: The IPSec preshared key
        project:
          type: string
          description: The project name of the VPN
        projectid:
          type: string
          description: The project ID of the VPN
        publicip:
          type: string
          description: The public IP address of the VPN server
        publicipid:
          type: string
          description: The public IP address of the VPN server
        state:
          type: string
          description: The state of the rule
    ResourceCount:
      type: object
      properties:
        account:
          type: string
          description: The Account for which resource count's are updated
        domain:
          type: string
          description: The domain name for which resource count's are updated
        domainid:
          type: string
          description: The domain ID for which resource count's are updated
        domainpath:
          type: string
          description: Path of the domain to which the resource counts are updated
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        project:
          type: string
          description: The project name for which resource count's are updated
        projectid:
          type: string
          description: The project ID for which resource count's are updated
        resourcecount:
          type: integer
          format: int64
          description: The resource count
        resourcetype:
          type: string
          description: Resource type. Values include 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.
        resourcetypename:
          type: string
          description: Resource type name. Values include user_vm, public_ip, volume, Snapshot, Template, project, Network, VPC, CPU, memory, primary_storage, secondary_storage.
        tag:
          type: string
          description: Tag for the resource
    ResourceIcon:
      type: object
      properties:
        base64image:
          type: string
          description: Base64 representation of resource icon
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        resourceid:
          type: string
          description: ID of the resource
        resourcetype:
          type: string
          x-cloudstack-type: resourceobjecttype
          description: Resource type
    ResourceLimit:
      type: object
      properties:
        account:
          type: string
          description: The Account of the resource limit
        domain:
          type: string
          description: The domain name of the resource limit
        domainid:
          type: string
          description: The domain ID of the resource limit
        domainpath:
          type: string
          description: Path of the domain to which the resource limit belongs
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        max:
          type: integer
          format: int64
          description: The maximum number of the resource. A -1 means the resource currently has no limit.
        project:
          type: string
          description: The project name of the resource limit
        projectid:
          type: string
          description: The project ID of the resource limit
        resourcetype:
          type: string
          description: Resource type. Values include 0, 1, 2, 3, 4, 6, 7, 8, 9, 10, 11. See the resourceType parameter for more information on these values.
        resourcetypename:
          type: string
          description: Resource type name. Values include user_vm, public_ip, volume, Snapshot, Template, project, Network, VPC, CPU, memory, primary_storage, secondary_storage.
        tag:
          type: string
          description: The tag for the resource limit
    ResourceSchedule:
      type: object
      properties:
        action:
          type: string
          x-cloudstack-type: action
          description: Action
        created:
          type: string
          x-cloudstack-type: date
          description: Date when the schedule was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: Description of resource schedule
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Schedule details
        enabled:
          type: boolean
          description: Resource schedule is enabled
        enddate:
          type: string
          x-cloudstack-type: date
          description: Date after which the schedule becomes inactive. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        id:
          type: string
          description: The ID of resource schedule
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        resourceid:
          type: string
          description: ID of the resource
        resourcetype:
          type: string
          x-cloudstack-type: apicommandresourcetype
          description: Type of the resource
        schedule:
          type: string
          description: Cron formatted resource schedule
        startdate:
          type: string
          x-cloudstack-type: date
          description: Date from which the schedule is active. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        timezone:
          type: string
          description: Timezone of the schedule
    Resources:
      type: object
      properties:
        created:
          type: string
          x-cloudstack-type: date
          description: Creation timestamp of the mapping. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: the details of the resource map
        id:
          type: string
          description: ID of the resource associated with the extension
        name:
          type: string
          description: Name of the resource associated with this mapping
        type:
          type: string
          description: Type of the resource
    Response:
      type: object
      properties:
        description:
          type: string
          description: Description of the API response field
        name:
          type: string
          description: The name of the API response field
        response:
          type: array
          items: {}
          x-cloudstack-type: set
          description: API response fields
        type:
          type: string
          description: Response field type
    Role:
      type: object
      properties:
        description:
          type: string
          description: The description of the role
        id:
          type: string
          description: The ID of the role
        isdefault:
          type: boolean
          description: True if role is default, false otherwise
        ispublic:
          type: boolean
          description: Indicates whether the role will be visible to all Users (public) or only to root admins (private). If this parameter is not specified during the creation of the role its value will be defaulted to true (public).
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the role
        state:
          type: string
          description: the state of the role
        type:
          type: string
          description: The type of the role
    RolePermission:
      type: object
      properties:
        description:
          type: string
          description: The description of the role permission
        id:
          type: string
          description: The ID of the role permission
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        permission:
          type: string
          description: The permission type of the api name or wildcard rule, allow/deny
        roleid:
          type: string
          description: The ID of the role to which the role permission belongs
        rolename:
          type: string
          description: The name of the role to which the role permission belongs
        rule:
          type: string
          description: The api name or wildcard rule
    RollingMaintenance:
      type: object
      properties:
        details:
          type: string
          description: In case of failure, details are displayed
        hostsskipped:
          type: array
          items:
            $ref: '#/components/schemas/Hostsskipped'
          x-cloudstack-type: list
          description: The hosts skipped
        hostsupdated:
          type: array
          items:
            $ref: '#/components/schemas/Hostsupdated'
          x-cloudstack-type: list
          description: The hosts updated
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        success:
          type: boolean
          description: Indicates if the rolling maintenance operation was successful
    Router:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the router
        arch:
          type: string
          description: CPU arch of the router
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the router was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        dns1:
          type: string
          description: The first DNS for the router
        dns2:
          type: string
          description: The second DNS for the router
        domain:
          type: string
          description: The domain associated with the router
        domainid:
          type: string
          description: The domain ID associated with the router
        domainpath:
          type: string
          description: path of the Domain the router belongs to
        gateway:
          type: string
          description: The gateway for the router
        guestipaddress:
          type: string
          description: The guest IP address for the router
        guestmacaddress:
          type: string
          description: The guest MAC address for the router
        guestnetmask:
          type: string
          description: The guest netmask for the router
        guestnetworkid:
          type: string
          description: The ID of the corresponding guest Network
        guestnetworkname:
          type: string
          description: The name of the corresponding guest Network
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        healthcheckresults:
          type: array
          items:
            $ref: '#/components/schemas/Healthcheckresults'
          x-cloudstack-type: list
          description: Last executed health check result for the router
        healthchecksfailed:
          type: boolean
          description: True if any health checks had failed
        hostcontrolstate:
          type: string
          description: The control state of the host for the router
        hostid:
          type: string
          description: The host ID for the router
        hostname:
          type: string
          description: The hostname for the router
        hypervisor:
          type: string
          description: The hypervisor on which the Template runs
        id:
          type: string
          description: The ID of the router
        ip6dns1:
          type: string
          description: The first IPv6 DNS for the router
        ip6dns2:
          type: string
          description: The second IPv6 DNS for the router
        isredundantrouter:
          type: boolean
          description: If this router is an redundant virtual router
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        linklocalip:
          type: string
          description: The Control IP address for the router
        linklocalmacaddress:
          type: string
          description: The link local MAC address for the router
        linklocalnetmask:
          type: string
          description: The link local netmask for the router
        linklocalnetworkid:
          type: string
          description: The ID of the corresponding link local Network
        name:
          type: string
          description: The name of the router
        networkdomain:
          type: string
          description: The Network domain for the router
        nic:
          type: array
          items:
            $ref: '#/components/schemas/Nic'
          x-cloudstack-type: set
          description: The list of NICs associated with the router
        podid:
          type: string
          description: The Pod ID for the router
        podname:
          type: string
          description: The Pod name for the router
        project:
          type: string
          description: The project name of the address
        projectid:
          type: string
          description: The project id of the IP address
        publicip:
          type: string
          description: The public IP address for the router
        publicmacaddress:
          type: string
          description: The public MAC address for the router
        publicnetmask:
          type: string
          description: The public netmask for the router
        publicnetworkid:
          type: string
          description: The ID of the corresponding public Network
        redundantstate:
          type: string
          description: The state of redundant virtual router
        requiresupgrade:
          type: boolean
          description: True if the router Template requires upgrade
        role:
          type: string
          description: Role of the domain router
        scriptsversion:
          type: string
          description: The version of scripts
        serviceofferingid:
          type: string
          description: The ID of the service offering of the Instance
        serviceofferingname:
          type: string
          description: The name of the service offering of the Instance
        softwareversion:
          type: string
          description: The version of the code / software in the router
        state:
          type: string
          x-cloudstack-type: state
          description: The state of the router
        templateid:
          type: string
          description: The Template ID for the router
        templatename:
          type: string
          description: The Template name for the router
        version:
          type: string
          description: The version of Template
        vpcid:
          type: string
          description: VPC the router belongs to
        vpcname:
          type: string
          description: The name of VPC the router belongs to
        zoneid:
          type: string
          description: The Zone ID for the router
        zonename:
          type: string
          description: The Zone name for the router
    RouterHealthCheckResult:
      type: object
      properties:
        healthchecks:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The ID of the router
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        routerid:
          type: string
          description: The ID of the router
    SSHKeyPair:
      type: object
      properties:
        account:
          type: string
          description: The owner of the keypair
        domain:
          type: string
          description: The domain name of the keypair owner
        domainid:
          type: string
          description: The domain id of the keypair owner
        fingerprint:
          type: string
          description: Fingerprint of the public key
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: ID of the SSH keypair
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the keypair
        privatekey:
          type: string
          description: Private key
        project:
          type: string
          description: The project name of the keypair owner
        projectid:
          type: string
          description: The project id of the keypair owner
    SSHKeyPair2:
      type: object
      properties:
        account:
          type: string
          description: The owner of the keypair
        domain:
          type: string
          description: The domain name of the keypair owner
        domainid:
          type: string
          description: The domain id of the keypair owner
        fingerprint:
          type: string
          description: Fingerprint of the public key
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: ID of the SSH keypair
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the keypair
        project:
          type: string
          description: The project name of the keypair owner
        projectid:
          type: string
          description: The project id of the keypair owner
    SecondaryStorageSelector:
      type: object
      properties:
        created:
          type: string
          x-cloudstack-type: date
          description: When the heuristic was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: Description of the heuristic.
        heuristicrule:
          type: string
          description: The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.
        id:
          type: string
          description: ID of the heuristic.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the heuristic.
        removed:
          type: string
          x-cloudstack-type: date
          description: When the heuristic was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        type:
          type: string
          description: 'The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, BACKUP, TEMPLATE and VOLUME.'
        zoneid:
          type: string
          description: The zone which the heuristic is valid upon.
    SecurityGroup:
      type: object
      properties:
        account:
          type: string
          description: The Account owning the security group
        description:
          type: string
          description: The description of the security group
        domain:
          type: string
          description: The domain name of the security group
        domainid:
          type: string
          description: The domain ID of the security group
        domainpath:
          type: string
          description: path of the Domain the security group belongs to
        egressrule:
          type: array
          items:
            $ref: '#/components/schemas/Ingressrule'
          x-cloudstack-type: set
          description: The list of egress rules associated with the security group
        id:
          type: string
          description: The ID of the security group
        ingressrule:
          type: array
          items:
            $ref: '#/components/schemas/Ingressrule'
          x-cloudstack-type: set
          description: The list of ingress rules associated with the security group
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the security group
        project:
          type: string
          description: The project name of the group
        projectid:
          type: string
          description: The project id of the group
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated with the rule
        virtualmachinecount:
          type: integer
          format: int32
          description: The number of Instances associated with this Security Group
        virtualmachineids:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The list of Instance IDs associated with this Security Group
    Securitygroup:
      type: object
      properties:
        account:
          type: string
          description: The Account owning the security group
        description:
          type: string
          description: The description of the security group
        domain:
          type: string
          description: The domain name of the security group
        domainid:
          type: string
          description: The domain ID of the security group
        domainpath:
          type: string
          description: path of the Domain the security group belongs to
        egressrule:
          type: array
          items:
            $ref: '#/components/schemas/Ingressrule'
          x-cloudstack-type: set
          description: The list of egress rules associated with the security group
        id:
          type: string
          description: The ID of the security group
        ingressrule:
          type: array
          items:
            $ref: '#/components/schemas/Ingressrule'
          x-cloudstack-type: set
          description: The list of ingress rules associated with the security group
        name:
          type: string
          description: The name of the security group
        project:
          type: string
          description: The project name of the group
        projectid:
          type: string
          description: The project id of the group
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated with the rule
        virtualmachinecount:
          type: integer
          format: int32
          description: The number of Instances associated with this Security Group
        virtualmachineids:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The list of Instance IDs associated with this Security Group
    Service:
      type: object
      properties:
        capability:
          type: array
          items:
            $ref: '#/components/schemas/Capability'
          x-cloudstack-type: list
          description: The list of capabilities
        name:
          type: string
          description: The service name
        provider:
          type: array
          items:
            $ref: '#/components/schemas/Provider'
          x-cloudstack-type: list
          description: The service provider name
    ServiceInstance:
      type: object
      properties:
        account:
          type: string
          description: The account associated with the Instance
        displayname:
          type: string
          description: User generated name. The name of the Instance is returned if no displayname exists.
        domain:
          type: string
          description: The name of the domain in which the Instance exists
        domainid:
          type: string
          description: The ID of the domain in which the Instance exists
        domainpath:
          type: string
          description: Path of the Domain in which the Instance exists
        id:
          type: string
          description: The ID of the Instance
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the Instance
        project:
          type: string
          description: The project name of the vm
        projectid:
          type: string
          description: The project ID of the Instance
    ServiceOffering:
      type: object
      properties:
        cacheMode:
          type: string
          description: The cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default
        cpunumber:
          type: integer
          format: int32
          description: The number of CPU
        cpuspeed:
          type: integer
          format: int32
          description: The clock rate CPU speed in Mhz
        created:
          type: string
          x-cloudstack-type: date
          description: The date this service offering was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        defaultuse:
          type: boolean
          description: Is this a default System VM offering
        deploymentplanner:
          type: string
          description: Deployment strategy used to deploy Instance.
        diskBytesReadRate:
          type: integer
          format: int64
          description: Bytes read rate of the service offering
        diskBytesReadRateMax:
          type: integer
          format: int64
          description: Burst bytes read rate of the disk offering
        diskBytesReadRateMaxLength:
          type: integer
          format: int64
          description: Length (in seconds) of the burst
        diskBytesWriteRate:
          type: integer
          format: int64
          description: Bytes write rate of the service offering
        diskBytesWriteRateMax:
          type: integer
          format: int64
          description: Burst bytes write rate of the disk offering
        diskBytesWriteRateMaxLength:
          type: integer
          format: int64
          description: Length (in seconds) of the burst
        diskIopsReadRate:
          type: integer
          format: int64
          description: I/O requests read rate of the service offering
        diskIopsReadRateMax:
          type: integer
          format: int64
          description: Burst io requests read rate of the disk offering
        diskIopsReadRateMaxLength:
          type: integer
          format: int64
          description: Length (in second) of the burst
        diskIopsWriteRate:
          type: integer
          format: int64
          description: I/O requests write rate of the service offering
        diskIopsWriteRateMax:
          type: integer
          format: int64
          description: Burst I/O requests write rate of the disk offering
        diskIopsWriteRateMaxLength:
          type: integer
          format: int64
          description: Length (in seconds) of the burst
        diskofferingdisplaytext:
          type: string
          description: The display text of the disk offering
        diskofferingid:
          type: string
          description: The ID of the disk offering to which service offering is linked
        diskofferingname:
          type: string
          description: Name of the disk offering
        diskofferingstrictness:
          type: boolean
          description: True/False to indicate the strictness of the disk offering association with the compute offering. When set to true, override of disk offering is not allowed when Instance is deployed and change disk offering is not allowed for the ROOT disk after the Instance is deployed
        displaytext:
          type: string
          description: An alternate display text of the service offering.
        domain:
          type: string
          description: The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        domainid:
          type: string
          description: The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        dynamicscalingenabled:
          type: boolean
          description: True if Instance needs to be dynamically scalable of CPU or memory
        encryptroot:
          type: boolean
          description: True if Instance root disk will be encrypted on storage
        gpucardid:
          type: string
          description: the ID of the gpu card to which service offering is linked
        gpucardname:
          type: string
          description: the name of the gpu card to which service offering is linked
        gpucount:
          type: integer
          format: int32
          description: the count of GPUs to attach
        gpudisplay:
          type: boolean
          description: whether GPU device is used for display or not
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hosttags:
          type: string
          description: The host tag for the service offering
        hypervisorsnapshotreserve:
          type: integer
          format: int32
          description: Hypervisor Snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)
        id:
          type: string
          description: The ID of the service offering
        iscustomized:
          type: boolean
          description: Is true if the offering is customized
        iscustomizediops:
          type: boolean
          description: True if disk offering uses custom IOPS, false otherwise
        issystem:
          type: boolean
          description: Is this a System VM offering
        isvolatile:
          type: boolean
          description: True if the Instance needs to be volatile, i.e., on every reboot of Instance from API root disk is discarded and creates a new root disk
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        leaseduration:
          type: integer
          format: int32
          description: Instance lease duration (in days) for service offering
        leaseexpiryaction:
          type: string
          description: Action to be taken once lease is over
        limitcpuuse:
          type: boolean
          description: Restrict the CPU usage to committed service offering
        maxheads:
          type: integer
          format: int64
          description: the maximum number of display heads
        maxiops:
          type: integer
          format: int64
          description: The max IOPS of the disk offering
        maxresolutionx:
          type: integer
          format: int64
          description: the maximum X resolution
        maxresolutiony:
          type: integer
          format: int64
          description: the maximum Y resolution
        memory:
          type: integer
          format: int32
          description: The memory in MB
        miniops:
          type: integer
          format: int64
          description: The min IOPS of the disk offering
        name:
          type: string
          description: The name of the service offering
        networkrate:
          type: integer
          format: int32
          description: Data transfer rate in megabits per second allowed.
        offerha:
          type: boolean
          description: The HA support in the service offering
        provisioningtype:
          type: string
          description: Provisioning type used to create volumes. Valid values are thin, sparse, fat.
        purgeresources:
          type: boolean
          description: Whether to cleanup VM and its associated resource upon expunge
        rootdisksize:
          type: integer
          format: int64
          description: Root disk size in GB
        serviceofferingdetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Additional key/value details tied with this service offering
        state:
          type: string
          description: State of the service offering
        storagetags:
          type: string
          description: The tags for the service offering
        storagetype:
          type: string
          description: The storage type for this service offering
        systemvmtype:
          type: string
          description: Is this a the System VM type for System VM offering
        vgpuprofileid:
          type: string
          description: the ID of the vgpu profile to which service offering is linked
        vgpuprofilename:
          type: string
          description: the name of the vgpu profile to which service offering is linked
        videoram:
          type: integer
          format: int64
          description: the video RAM size in MB
        vspherestoragepolicy:
          type: string
          description: The vsphere storage policy tagged to the service offering in case of VMware
        zone:
          type: string
          description: The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        zoneid:
          type: string
          description: The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
    SetupUserTwoFactorAuthentication:
      type: object
      properties:
        accountid:
          type: string
          description: The Account ID of the user
        id:
          type: string
          description: The user ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        secretcode:
          type: string
          description: Secret code that needs to be registered with authenticator
        username:
          type: string
          description: The user name
    SharedFileSystem:
      type: object
      properties:
        account:
          type: string
          description: the account associated with the shared filesystem
        description:
          type: string
          description: description of the shared filesystem
        diskioread:
          type: integer
          format: int64
          description: the read (IO) of disk on the shared filesystem
        diskiowrite:
          type: integer
          format: int64
          description: the write (IO) of disk on the shared filesystem
        diskkbsread:
          type: integer
          format: int64
          description: the shared filesystem's disk read in KiB
        diskkbswrite:
          type: integer
          format: int64
          description: the shared filesystem's disk write in KiB
        diskofferingdisplaytext:
          type: string
          description: disk offering display text for the shared filesystem
        diskofferingid:
          type: string
          description: disk offering ID for the shared filesystem
        diskofferingname:
          type: string
          description: disk offering for the shared filesystem
        domain:
          type: string
          description: the domain associated with the shared filesystem
        domainid:
          type: string
          description: the ID of the domain associated with the shared filesystem
        domainpath:
          type: string
          description: path of the domain to which the shared filesystem
        filesystem:
          type: string
          description: the filesystem format
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: ID of the shared filesystem
        iscustomdiskoffering:
          type: boolean
          description: disk offering for the shared filesystem has custom size
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: name of the shared filesystem
        networkid:
          type: string
          description: Network ID of the shared filesystem
        networkname:
          type: string
          description: Network name of the shared filesystem
        nic:
          type: array
          items:
            $ref: '#/components/schemas/Nic'
          x-cloudstack-type: list
          description: the list of nics associated with the shared filesystem
        path:
          type: string
          description: path to mount the shared filesystem
        physicalsize:
          type: integer
          format: int64
          description: the bytes actually consumed on disk
        project:
          type: string
          description: the project name of the shared filesystem
        projectid:
          type: string
          description: the project ID of the shared filesystem
        provider:
          type: string
          description: the shared filesystem provider
        provisioningtype:
          type: string
          description: provisioning type used in the shared filesystem
        serviceofferingid:
          type: string
          description: service offering ID for the shared filesystem
        serviceofferingname:
          type: string
          description: service offering for the shared filesystem
        size:
          type: integer
          format: int64
          description: size of the shared filesystem
        sizegb:
          type: string
          description: size of the shared filesystem in GiB
        state:
          type: string
          description: the state of the shared filesystem
        storage:
          type: string
          description: name of the storage pool hosting the data volume
        storageid:
          type: string
          description: ID of the storage pool hosting the data volume
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        utilization:
          type: string
          description: the disk utilization
        virtualmachineid:
          type: string
          description: ID of the storage fs vm
        virtualsize:
          type: integer
          format: int64
          description: the bytes allocated
        vmstate:
          type: string
          description: ID of the storage fs vm
        volumeid:
          type: string
          description: ID of the storage fs data volume
        volumename:
          type: string
          description: name of the storage fs data volume
        zoneid:
          type: string
          description: ID of the availability zone
        zonename:
          type: string
          description: Name of the availability zone
    SiocInfo:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        msg:
          type: string
          description: The return message from the operation ('Success' if successful)
    Snapshot:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the Snapshot
        chainsize:
          type: integer
          format: int64
          description: chain size of snapshot including all parent snapshots. Shown only for incremental snapshots if snapshot.show.chain.size setting is set to true
        created:
          type: string
          x-cloudstack-type: date
          description: The date the Snapshot was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        datastoreid:
          type: string
          description: ID of the datastore for the snapshot entry
        datastorename:
          type: string
          description: name of the datastore for the snapshot entry
        datastorestate:
          type: string
          description: state of the snapshot on the datastore
        datastoretype:
          type: string
          description: type of the datastore for the snapshot entry
        domain:
          type: string
          description: The domain name of the Snapshot's Account
        domainid:
          type: string
          description: The domain ID of the Snapshot's Account
        domainpath:
          type: string
          description: path of the Domain the snapshot's account belongs to
        downloaddetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: download progress of a snapshot
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: ID of the Snapshot
        intervaltype:
          type: string
          description: Valid types are hourly, daily, weekly, monthy, Template, and none.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        locationtype:
          type: string
          description: Valid location types are primary and secondary.
        name:
          type: string
          description: Name of the Snapshot
        osdisplayname:
          type: string
          description: Display name of the os on volume
        ostypeid:
          type: string
          description: ID of the os on volume
        parent:
          type: string
          description: The parent ID of the Snapshot
        parentname:
          type: string
          description: The parent name of the Snapshot
        physicalsize:
          type: integer
          format: int64
          description: Physical size of backed up Snapshot on image store
        project:
          type: string
          description: The project name of the Snapshot
        projectid:
          type: string
          description: The project id of the Snapshot
        revertable:
          type: boolean
          description: Indicates whether the underlying storage supports reverting the volume to this Snapshot
        snapshottype:
          type: string
          description: The type of the Snapshot
        state:
          type: string
          x-cloudstack-type: state
          description: The state of the Snapshot. BackedUp means that Snapshot is ready to be used; Creating - the Snapshot is being allocated on the primary storage; BackingUp - the Snapshot is being backed up on secondary storage
        status:
          type: string
          description: the status of the template
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        virtualsize:
          type: integer
          format: int64
          description: Virtual size of backedup Snapshot on image store
        volumeid:
          type: string
          description: ID of the disk volume
        volumename:
          type: string
          description: Name of the disk volume
        volumestate:
          type: string
          description: state of the disk volume
        volumetype:
          type: string
          description: Type of the disk volume
        zoneid:
          type: string
          description: ID of the availability zone
        zonename:
          type: string
          description: name of the availability zone
    SnapshotPolicy:
      type: object
      properties:
        fordisplay:
          type: boolean
          description: Is this policy for display to the regular user
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The ID of the Snapshot policy
        intervaltype:
          type: integer
          format: int32
          description: The interval type of the Snapshot policy
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        maxsnaps:
          type: integer
          format: int32
          description: Maximum number of Snapshots retained
        schedule:
          type: string
          description: Time the Snapshot is scheduled to be taken.
        storage:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The list of pools in which snapshot backup is scheduled
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        timezone:
          type: string
          description: The time zone of the Snapshot policy
        volumeid:
          type: string
          description: The ID of the disk volume
        volumename:
          type: string
          description: the name of the disk volume
        zone:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The list of zones in which snapshot backup is scheduled
    SolidFireAccountId:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        solidFireAccountId:
          type: integer
          format: int64
          description: SolidFire Account ID
    SolidFireVolumeAccessGroupId:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        solidFireVolumeAccessGroupIds:
          type: array
          items:
            type: integer
            format: int64
          description: SolidFire Volume Access Group Ids
    SolidFireVolumeSize:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        solidFireVolumeSize:
          type: integer
          format: int64
          description: SolidFire Volume Size Including Hypervisor Snapshot Reserve
    SslCert:
      type: object
      properties:
        account:
          type: string
          description: Account for the certificate
        certchain:
          type: string
          description: Certificate chain
        certificate:
          type: string
          description: Certificate
        domain:
          type: string
          description: The domain name of the Network owner
        domainid:
          type: string
          description: The domain id of the Network owner
        fingerprint:
          type: string
          description: Certificate fingerprint
        id:
          type: string
          description: SSL certificate ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        loadbalancerrulelist:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List of loabalancers this certificate is bound to
        name:
          type: string
          description: Name
        project:
          type: string
          description: The project name of the certificate
        projectid:
          type: string
          description: The project id of the certificate
    StaticRoute:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the static route
        cidr:
          type: string
          description: Static route CIDR
        domain:
          type: string
          description: The domain associated with the static route
        domainid:
          type: string
          description: The ID of the domain associated with the static route
        domainpath:
          type: string
          description: the domain path associated with the static route
        id:
          type: string
          description: The ID of static route
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        nexthop:
          type: string
          description: Next hop of the static route
        project:
          type: string
          description: The project name of the static route
        projectid:
          type: string
          description: The project ID of the static route
        state:
          type: string
          description: The state of the static route
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with static route
        vpcgatewayid:
          type: string
          description: VPC gateway the route is created for
        vpcgatewayip:
          type: string
          description: IP of VPC gateway the route is created for
        vpcid:
          type: string
          description: VPC the static route belongs to
    Stats:
      type: object
      properties:
        cpuused:
          type: string
          description: The amount (percentage) of the Instance's CPU currently used
        diskiopstotal:
          type: integer
          format: int64
          description: The total disk IOPS since the last stats retrieval
        diskioread:
          type: integer
          format: int64
          description: The Instance's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
        diskiowrite:
          type: integer
          format: int64
          description: The Instance's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration
        diskkbsread:
          type: integer
          format: int64
          description: The Instance's disk read in KiB
        diskkbswrite:
          type: integer
          format: int64
          description: The Instance's disk write in KiB
        memoryintfreekbs:
          type: integer
          format: int64
          description: The Instance's free memory in KB or -1 if it cannot be gathered
        memorykbs:
          type: integer
          format: int64
          description: The memory used by the Instance in KB
        memorytargetkbs:
          type: integer
          format: int64
          description: The target memory in Instance (KB)
        networkkbsread:
          type: integer
          format: int64
          description: The incoming Network traffic on the Instance in KiB
        networkkbswrite:
          type: integer
          format: int64
          description: The outgoing Network traffic on the host in KiB
        networkread:
          type: string
          description: The amount of downloaded data by the Instance in MiB
        networkwrite:
          type: string
          description: The amount of uploaded data by the Instance in MiB
        timestamp:
          type: string
          x-cloudstack-type: date
          description: The time when the Instance stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
    Stickinesspolicy:
      type: object
      properties:
        description:
          type: string
          description: The description of the Stickiness policy
        fordisplay:
          type: boolean
          description: Is policy for display to the regular user
        id:
          type: string
          description: The LB Stickiness policy ID
        methodname:
          type: string
          description: The method name of the Stickiness policy
        name:
          type: string
          description: The name of the Stickiness policy
        params:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: The params of the policy
        state:
          type: string
          description: The state of the policy
    StorageAccessGroup:
      type: object
      properties:
        clusters:
          type: object
          x-cloudstack-type: listresponse
          description: List of Clusters in the Storage Access Group
        hosts:
          type: object
          x-cloudstack-type: listresponse
          description: List of Hosts in the Storage Access Group
        id:
          type: string
          description: the ID of the storage access group
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: the name of the storage access group
        pods:
          type: object
          x-cloudstack-type: listresponse
          description: List of Pods in the Storage Access Group
        storagepools:
          type: object
          x-cloudstack-type: listresponse
          description: List of Storage Pools in the Storage Access Group
        zones:
          type: object
          x-cloudstack-type: listresponse
          description: List of Zones in the Storage Access Group
    StorageNetworkIpRange:
      type: object
      properties:
        endip:
          type: string
          description: The end IP of the storage Network IP range
        gateway:
          type: string
          description: The gateway of the storage Network IP range
        id:
          type: string
          description: The UUID of storage Network IP range.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        netmask:
          type: string
          description: The netmask of the storage Network IP range
        networkid:
          type: string
          description: The Network UUID of storage Network IP range
        podid:
          type: string
          description: The Pod UUID for the storage Network IP range
        startip:
          type: string
          description: The start IP of the storage Network IP range
        vlan:
          type: integer
          format: int32
          description: The ID or VID of the VLAN.
        zoneid:
          type: string
          description: The Zone UUID of the storage Network IP range
    StoragePool:
      type: object
      properties:
        allocatediops:
          type: integer
          format: int64
          description: Total min IOPS currently in use by volumes
        capacitybytes:
          type: integer
          format: int64
          description: bytes CloudStack can provision from this storage pool
        capacityiops:
          type: integer
          format: int64
          description: IOPS CloudStack can provision from this storage pool
        clusterid:
          type: string
          description: The ID of the cluster for the storage pool
        clustername:
          type: string
          description: The name of the cluster for the storage pool
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the storage pool was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: the storage pool details
        disksizeallocated:
          type: integer
          format: int64
          description: The pool's currently allocated disk size
        disksizetotal:
          type: integer
          format: int64
          description: The total disk size of the storage pool
        disksizeused:
          type: integer
          format: int64
          description: The pool's currently used disk size
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hypervisor:
          type: string
          description: The hypervisor type of the storage pool
        id:
          type: string
          description: The ID of the storage pool
        ipaddress:
          type: string
          description: The IP address of the storage pool
        istagarule:
          type: boolean
          description: Whether the informed tag is a JS interpretable rule or not.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        managed:
          type: boolean
          description: whether this pool is managed or not
        name:
          type: string
          description: The name of the storage pool
        nfsmountopts:
          type: string
          description: the nfs mount options for the storage pool
        overprovisionfactor:
          type: string
          description: The overprovisionfactor for the storage pool
        path:
          type: string
          description: The storage pool path
        podid:
          type: string
          description: The Pod ID of the storage pool
        podname:
          type: string
          description: The Pod name of the storage pool
        provider:
          type: string
          description: Storage provider for this pool
        scope:
          type: string
          description: The scope of the storage pool
        state:
          type: string
          x-cloudstack-type: storagepoolstatus
          description: The state of the storage pool
        storageaccessgroups:
          type: string
          description: the storage access groups for the storage pool
        storagecapabilities:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: The storage pool capabilities
        storagecustomstats:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: the storage pool custom stats
        suitableformigration:
          type: boolean
          description: True if this pool is suitable to migrate a volume, false otherwise
        tags:
          type: string
          description: The tags for the storage pool
        type:
          type: string
          description: The storage pool type
        usediops:
          type: integer
          format: int64
          description: total IOPS currently in use
        zoneid:
          type: string
          description: The Zone ID of the storage pool
        zonename:
          type: string
          description: The Zone name of the storage pool
    StoragePoolsMetric:
      type: object
      properties:
        allocatediops:
          type: integer
          format: int64
          description: Total min IOPS currently in use by volumes
        capacitybytes:
          type: integer
          format: int64
          description: bytes CloudStack can provision from this storage pool
        capacityiops:
          type: integer
          format: int64
          description: IOPS CloudStack can provision from this storage pool
        clusterid:
          type: string
          description: The ID of the cluster for the storage pool
        clustername:
          type: string
          description: The name of the cluster for the storage pool
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the storage pool was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: the storage pool details
        disksizeallocated:
          type: integer
          format: int64
          description: The pool's currently allocated disk size
        disksizeallocatedgb:
          type: string
          description: Disk size allocated in GiB
        disksizetotal:
          type: integer
          format: int64
          description: The total disk size of the storage pool
        disksizetotalgb:
          type: string
          description: Disk size in GiB
        disksizeunallocatedgb:
          type: string
          description: Disk size unallocated in GiB
        disksizeused:
          type: integer
          format: int64
          description: The pool's currently used disk size
        disksizeusedgb:
          type: string
          description: Disk size used in GiB
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hypervisor:
          type: string
          description: The hypervisor type of the storage pool
        id:
          type: string
          description: The ID of the storage pool
        ipaddress:
          type: string
          description: The IP address of the storage pool
        istagarule:
          type: boolean
          description: Whether the informed tag is a JS interpretable rule or not.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        managed:
          type: boolean
          description: whether this pool is managed or not
        name:
          type: string
          description: The name of the storage pool
        nfsmountopts:
          type: string
          description: the nfs mount options for the storage pool
        overprovisionfactor:
          type: string
          description: The overprovisionfactor for the storage pool
        path:
          type: string
          description: The storage pool path
        podid:
          type: string
          description: The Pod ID of the storage pool
        podname:
          type: string
          description: The Pod name of the storage pool
        provider:
          type: string
          description: Storage provider for this pool
        scope:
          type: string
          description: The scope of the storage pool
        state:
          type: string
          x-cloudstack-type: storagepoolstatus
          description: The state of the storage pool
        storageaccessgroups:
          type: string
          description: the storage access groups for the storage pool
        storageallocateddisablethreshold:
          type: boolean
          description: Storage allocated disable threshold exceeded
        storageallocatedthreshold:
          type: boolean
          description: Storage allocated notification threshold exceeded
        storagecapabilities:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: The storage pool capabilities
        storagecustomstats:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: the storage pool custom stats
        storageusagedisablethreshold:
          type: boolean
          description: Storage usage disable threshold exceeded
        storageusagethreshold:
          type: boolean
          description: Storage usage notification threshold exceeded
        suitableformigration:
          type: boolean
          description: True if this pool is suitable to migrate a volume, false otherwise
        tags:
          type: string
          description: The tags for the storage pool
        type:
          type: string
          description: The storage pool type
        usediops:
          type: integer
          format: int64
          description: total IOPS currently in use
        zoneid:
          type: string
          description: The Zone ID of the storage pool
        zonename:
          type: string
          description: The Zone name of the storage pool
    StorageProvider:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the storage provider
        type:
          type: string
          description: 'The type of the storage provider: primary or image provider'
    StorageTag:
      type: object
      properties:
        id:
          type: string
          description: The ID of the storage tag
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the storage tag
        poolid:
          type: integer
          format: int64
          description: The pool ID of the storage tag
    StratosphereSsp:
      type: object
      properties:
        hostid:
          type: string
          description: Server ID of the stratosphere ssp server
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name
        url:
          type: string
          description: URL of ssp endpoint
        zoneid:
          type: string
          description: Zone which this ssp controls
    Subgroup:
      type: object
      properties:
        name:
          type: string
          description: The name of the configuration subgroup
        precedence:
          type: integer
          format: int64
          description: The precedence of the configuration subgroup
    SuccessResult:
      type: object
      properties:
        displaytext:
          type: string
          description: Any text associated with the success or failure
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        success:
          type: boolean
          description: True if operation is executed successfully
    SupportedNetworkService:
      type: object
      properties:
        capability:
          type: array
          items:
            $ref: '#/components/schemas/Capability'
          x-cloudstack-type: list
          description: The list of capabilities
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The service name
        provider:
          type: array
          items:
            $ref: '#/components/schemas/Provider'
          x-cloudstack-type: list
          description: The service provider name
    SystemVm:
      type: object
      properties:
        activeviewersessions:
          type: integer
          format: int32
          description: The number of active console sessions for the console proxy System VM
        agentstate:
          type: string
          description: The agent state of the System VM
        arch:
          type: string
          description: CPU arch of the system VM
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the System VM was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        disconnected:
          type: string
          x-cloudstack-type: date
          description: The last disconnected date of host. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        dns1:
          type: string
          description: The first DNS for the System VM
        dns2:
          type: string
          description: The second DNS for the System VM
        gateway:
          type: string
          description: The gateway for the System VM
        guestvlan:
          type: string
          description: Guest VLAN range
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hostcontrolstate:
          type: string
          description: The control state of the host for the System VM
        hostid:
          type: string
          description: The host ID for the System VM
        hostname:
          type: string
          description: The hostname for the System VM
        hypervisor:
          type: string
          description: The hypervisor on which the Template runs
        id:
          type: string
          description: The ID of the System VM
        isdynamicallyscalable:
          type: boolean
          description: True if the Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        linklocalip:
          type: string
          description: The Control IP address for the System VM
        linklocalmacaddress:
          type: string
          description: The link local MAC address for the System VM
        linklocalnetmask:
          type: string
          description: The link local netmask for the System VM
        name:
          type: string
          description: The name of the System VM
        networkdomain:
          type: string
          description: The Network domain for the System VM
        podid:
          type: string
          description: The Pod ID for the System VM
        podname:
          type: string
          description: The Pod name for the System VM
        privateip:
          type: string
          description: The private IP address for the System VM
        privatemacaddress:
          type: string
          description: The private MAC address for the System VM
        privatenetmask:
          type: string
          description: The private netmask for the System VM
        publicip:
          type: string
          description: The public IP address for the System VM
        publicmacaddress:
          type: string
          description: The public MAC address for the System VM
        publicnetmask:
          type: string
          description: The public netmask for the System VM
        publicvlan:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Public VLAN range
        serviceofferingid:
          type: string
          description: the ID of the service offering of the system virtual machine.
        serviceofferingname:
          type: string
          description: the name of the service offering of the system virtual machine.
        state:
          type: string
          description: The state of the System VM
        storageip:
          type: string
          description: the ip address for the system VM on the storage network
        systemvmtype:
          type: string
          description: The System VM type
        templateid:
          type: string
          description: The Template ID for the System VM
        templatename:
          type: string
          description: The Template name for the System VM
        version:
          type: string
          description: The systemvm agent version
        zoneid:
          type: string
          description: The Zone ID for the System VM
        zonename:
          type: string
          description: The Zone name for the System VM
    Tags:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the tag
        customer:
          type: string
          description: Customer associated with the tag
        domain:
          type: string
          description: The domain associated with the tag
        domainid:
          type: string
          description: The ID of the domain associated with the tag
        domainpath:
          type: string
          description: Path of the Domain associated with the tag
        key:
          type: string
          description: Tag key name
        project:
          type: string
          description: The project name where tag belongs to
        projectid:
          type: string
          description: The project ID the tag belongs to
        resourceid:
          type: string
          description: ID of the resource
        resourcetype:
          type: string
          description: Resource type
        value:
          type: string
          description: Tag value
    Template:
      type: object
      properties:
        account:
          type: string
          description: The Account name to which the Template belongs
        accountid:
          type: string
          description: The Account id to which the Template belongs
        arch:
          type: string
          description: CPU Arch of the template
        bits:
          type: integer
          format: int32
          description: The processor bit size
        bootable:
          type: boolean
          description: True if the ISO is bootable, false otherwise
        checksum:
          type: string
          description: Checksum of the Template
        childtemplates:
          type: array
          items: {}
          x-cloudstack-type: set
          description: If root disk Template, then IDs of the datas disk Templates this Template owns
        created:
          type: string
          x-cloudstack-type: date
          description: The date this Template was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        crossZones:
          type: boolean
          description: True if the Template is managed across all Zones, false otherwise
        deployasis:
          type: boolean
          description: 'VMware only: true if Template is deployed without orchestrating disks and Networks but "as-is" defined in the Template.'
        deployasisdetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: 'VMware only: additional key/value details tied with deploy-as-is Template'
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Additional key/value details tied with Template
        directdownload:
          type: boolean
          description: 'KVM Only: true if Template is directly downloaded to Primary Storage bypassing Secondary Storage'
        displaytext:
          type: string
          description: The Template display text
        domain:
          type: string
          description: The name of the domain to which the Template belongs
        domainid:
          type: string
          description: The ID of the domain to which the Template belongs
        domainpath:
          type: string
          description: Path of the Domain the template belongs to
        downloaddetails:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Lists the download progress of a Template across all secondary storages
        extensionid:
          type: string
          description: The ID of extension linked to this template
        extensionname:
          type: string
          description: The name of extension linked to this template
        forcks:
          type: boolean
          description: If true it indicates that the template can be used for CKS cluster deployments
        format:
          type: string
          x-cloudstack-type: imageformat
          description: The format of the Template.
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hostid:
          type: string
          description: The ID of the secondary storage host for the Template
        hostname:
          type: string
          description: The name of the secondary storage host for the Template
        hypervisor:
          type: string
          description: The hypervisor on which the Template runs
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The Template ID
        isdynamicallyscalable:
          type: boolean
          description: True if Template contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory
        isextractable:
          type: boolean
          description: True if the Template is extractable, false otherwise
        isfeatured:
          type: boolean
          description: True if this Template is a featured Template, false otherwise
        ispublic:
          type: boolean
          description: True if this Template is a public Template, false otherwise
        isready:
          type: boolean
          description: True if the Template is ready to be deployed from, false otherwise.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The Template name
        ostypeid:
          type: string
          description: The ID of the OS type for this Template.
        ostypename:
          type: string
          description: The name of the OS type for this Template.
        parenttemplateid:
          type: string
          description: If Datadisk Template, then id of the root disk Template this Template belongs to
        passwordenabled:
          type: boolean
          description: True if the reset password feature is enabled, false otherwise
        physicalsize:
          type: integer
          format: int64
          description: The physical size of the Template
        project:
          type: string
          description: The project name of the Template
        projectid:
          type: string
          description: The project ID of the Template
        removed:
          type: string
          x-cloudstack-type: date
          description: The date this Template was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        requireshvm:
          type: boolean
          description: True if Template requires HVM enabled, false otherwise
        size:
          type: integer
          format: int64
          description: The size of the Template
        sourcetemplateid:
          type: string
          description: The Template ID of the parent Template if present
        sshkeyenabled:
          type: boolean
          description: True if Template is sshkey enabled, false otherwise
        status:
          type: string
          description: The status of the Template
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        templatetag:
          type: string
          description: The tag of this Template
        templatetype:
          type: string
          description: The type of the Template
        url:
          type: string
          description: The URL which the Template/ISO is registered from
        userdataid:
          type: string
          description: The id of userdata linked to this Template
        userdataname:
          type: string
          description: The name of userdata linked to this Template
        userdataparams:
          type: string
          description: List of parameters which contains the list of keys or string parameters that are needed to be passed for any variables declared in userdata
        userdatapolicy:
          type: string
          description: The userdata override policy with the userdata provided while deploying Instance
        zoneid:
          type: string
          description: The ID of the zone for this Template
        zonename:
          type: string
          description: The name of the zone for this Template
    TemplateDirectDownloadCertificate:
      type: object
      properties:
        alias:
          type: string
          description: The direct download certificate alias
        hostsmap:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The hosts where the certificate is uploaded to
        hypervisor:
          type: string
          description: The hypervisor of the hosts where the certificate is uploaded
        id:
          type: string
          description: The direct download certificate ID
        issuer:
          type: string
          description: The direct download certificate issuer
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        serialnum:
          type: string
          description: The direct download certificate serial num
        subject:
          type: string
          description: The direct download certificate subject
        validity:
          type: string
          description: The direct download certificate issuer
        version:
          type: string
          description: The direct download certificate version
        zoneid:
          type: string
          description: The zone ID where the certificate is uploaded
        zonename:
          type: string
          description: The zone name where the certificate is uploaded
    TemplateDirectDownloadCertificate2:
      type: object
      properties:
        details:
          type: string
          description: Indicates the details in case of failure or host skipped
        hostid:
          type: string
          description: The ID of the host
        hostname:
          type: string
          description: The name of the host
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        status:
          type: string
          description: Indicates if the certificate has been revoked from the host, failed or skipped
    TrafficMonitor:
      type: object
      properties:
        id:
          type: string
          description: The ID of the external firewall
        ipaddress:
          type: string
          description: The management IP address of the external firewall
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        numretries:
          type: string
          description: The number of times to retry requests to the external firewall
        timeout:
          type: string
          description: The timeout (in seconds) for requests to the external firewall
        zoneid:
          type: string
          description: The zone ID of the external firewall
    TrafficType:
      type: object
      properties:
        hypervnetworklabel:
          type: string
          description: The Network name label of the physical device dedicated to this traffic on a HyperV host
        id:
          type: string
          description: ID of the Network provider
        isolationmethods:
          type: string
          description: isolation methods for the physical network traffic
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        kvmnetworklabel:
          type: string
          description: The Network name label of the physical device dedicated to this traffic on a KVM host
        ovm3networklabel:
          type: string
          description: The Network name of the physical device dedicated to this traffic on an OVM3 host
        physicalnetworkid:
          type: string
          description: The physical Network this belongs to
        traffictype:
          type: string
          description: The trafficType to be added to the physical Network
        vlan:
          type: string
          description: The VLAN id to be used for Management traffic by VMware host
        vmwarenetworklabel:
          type: string
          description: The Network name label of the physical device dedicated to this traffic on a VMware host
        xennetworklabel:
          type: string
          description: The Network name label of the physical device dedicated to this traffic on a XenServer host
    TrafficTypeImplementor:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        traffictype:
          type: string
          description: Network traffic type
        traffictypeimplementor:
          type: string
          description: Implementor of Network traffic type
    TungstenFabricAddressGroup:
      type: object
      properties:
        ipprefix:
          type: string
          description: Tungsten-Fabric address group IP prefix
        ipprefixlen:
          type: integer
          format: int32
          description: Tungsten-Fabric address group IP prefix length
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric address group name
        uuid:
          type: string
          description: Tungsten-Fabric address group UUID
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone ID
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricApplicationPolicySet:
      type: object
      properties:
        firewallpolicy:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List Tungsten-Fabric firewall policy
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric policy name
        tag:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List Tungsten-Fabric tag
        uuid:
          type: string
          description: Tungsten-Fabric application policy uuid
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricFirewallPolicy:
      type: object
      properties:
        firewallrule:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List Tungsten-Fabric firewall rule
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric firewall policy name
        uuid:
          type: string
          description: Tungsten-Fabric firewall policy uuid
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricFirewallRule:
      type: object
      properties:
        action:
          type: string
          description: Tungsten-Fabric firewall rule action
        destaddressgroup:
          type: string
          description: Tungsten-Fabric firewall rule destination address group
        destnetwork:
          type: string
          description: Tungsten-Fabric firewall rule destination network
        desttag:
          type: string
          description: Tungsten-Fabric firewall rule destination tag
        direction:
          type: string
          description: Tungsten-Fabric firewall rule direction
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric firewall rule name
        servicegroup:
          type: string
          description: Tungsten-Fabric firewall rule service group
        srcaddressgroup:
          type: string
          description: Tungsten-Fabric firewall rule source address group
        srcnetwork:
          type: string
          description: Tungsten-Fabric firewall rule source network
        srctag:
          type: string
          description: Tungsten-Fabric firewall rule source tag
        tagtype:
          type: string
          description: Tungsten-Fabric firewall rule tag type
        uuid:
          type: string
          description: Tungsten-Fabric firewall rule uuid
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricLBHealthMonitor:
      type: object
      properties:
        expectedcode:
          type: string
          description: The health monitor expected code
        httpmethod:
          type: string
          description: The health monitor HTTP method
        id:
          type: integer
          format: int64
          description: The health monitor ID
        interval:
          type: integer
          format: int32
          description: The health monitor interval
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lbruleid:
          type: string
          description: The LB rule ID
        retry:
          type: integer
          format: int32
          description: The health monitor retry
        timeout:
          type: integer
          format: int32
          description: The health monitor timeout
        type:
          type: string
          description: The health monitor type
        urlpath:
          type: string
          description: The health monitor URL path
        uuid:
          type: string
          description: The health monitor UUID
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone ID
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricPolicy:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric logical router name
        network:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List Tungsten-Fabric policy network name
        uuid:
          type: string
          description: Tungsten-Fabric logical router uuid
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricPolicyRule:
      type: object
      properties:
        action:
          type: string
          description: Tungsten-Fabric policy action
        destendport:
          type: integer
          format: int32
          description: Tungsten-Fabric policy destination end port
        destipprefix:
          type: string
          description: Tungsten-Fabric policy destination ip prefix
        destipprefixlen:
          type: integer
          format: int32
          description: Tungsten-Fabric policy destination ip prefix length
        destnetwork:
          type: string
          description: Tungsten-Fabric policy destination network
        deststartport:
          type: integer
          format: int32
          description: Tungsten-Fabric policy destination start port
        direction:
          type: string
          description: Tungsten-Fabric policy name
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        policyuuid:
          type: string
          description: Tungsten-Fabric policy uuid
        protocol:
          type: string
          description: Tungsten-Fabric policy protocol
        srcendport:
          type: integer
          format: int32
          description: Tungsten-Fabric policy source end port
        srcipprefix:
          type: string
          description: Tungsten-Fabric policy source ip prefix
        srcipprefixlen:
          type: integer
          format: int32
          description: Tungsten-Fabric policy source ip prefix length
        srcnetwork:
          type: string
          description: Tungsten-Fabric policy source network
        srcstartport:
          type: integer
          format: int32
          description: Tungsten-Fabric policy source start port
        uuid:
          type: string
          description: Tungsten-Fabric rule uuid
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricProvider:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric provider name
        securitygroupsenabled:
          type: boolean
          description: True if security groups support is enabled, false otherwise
        tungstengateway:
          type: string
          description: Tungsten-Fabric provider gateway
        tungstenproviderhostname:
          type: string
          description: Tungsten-Fabric provider hostname
        tungstenproviderintrospectport:
          type: string
          description: Tungsten-Fabric provider introspect port
        tungstenproviderport:
          type: string
          description: Tungsten-Fabric provider port
        tungstenprovideruuid:
          type: string
          description: Tungsten-Fabric provider uuid
        tungstenprovidervrouterport:
          type: string
          description: Tungsten-Fabric provider vrouter port
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricServiceGroup:
      type: object
      properties:
        endport:
          type: integer
          format: int32
          description: Tungsten-Fabric service group end port
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric service group name
        protocol:
          type: string
          description: Tungsten-Fabric service group protocol
        startport:
          type: integer
          format: int32
          description: Tungsten-Fabric service group start port
        uuid:
          type: string
          description: Tungsten-Fabric service group uuid
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricTag:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric tag name
        network:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List Tungsten-Fabric network
        nic:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List Tungsten-Fabric NIC
        policy:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List Tungsten-Fabric policy
        uuid:
          type: string
          description: Tungsten-Fabric tag type uuid
        vm:
          type: array
          items: {}
          x-cloudstack-type: list
          description: List Tungsten-Fabric Instance
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    TungstenFabricTagType:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Tungsten-Fabric tag type name
        uuid:
          type: string
          description: Tungsten-Fabric tag type uuid
        zoneid:
          type: integer
          format: int64
          description: Tungsten-Fabric provider zone id
        zonename:
          type: string
          description: Tungsten-Fabric provider zone name
    UcsManager:
      type: object
      properties:
        id:
          type: string
          description: The ID of the UCS manager
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of UCS manager
        url:
          type: string
          description: The URL of UCS manager
        zoneid:
          type: string
          description: The zone ID of UCS manager
    UcsProfile:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        ucsdn:
          type: string
          description: UCS profile dn
    UsageRecord:
      type: object
      properties:
        account:
          type: string
          description: The user Account name
        accountid:
          type: string
          description: The user Account ID
        cpunumber:
          type: integer
          format: int64
          description: Number of CPU of resource
        cpuspeed:
          type: integer
          format: int64
          description: Speed of each CPU of resource
        description:
          type: string
          description: Description of the usage record
        domain:
          type: string
          description: The domain the resource is associated with
        domainid:
          type: string
          description: The domain ID
        domainpath:
          type: string
          description: Path of the domain to which the usage reocrd belongs
        enddate:
          type: string
          x-cloudstack-type: date
          description: End date of the usage record. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        isdefault:
          type: boolean
          description: True if the resource is default
        issourcenat:
          type: boolean
          description: True if the IPAddress is source NAT
        issystem:
          type: boolean
          description: True if the IPAddress is system IP - allocated during Instance deploy or LB rule create
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        memory:
          type: integer
          format: int64
          description: Memory allocated for the resource
        name:
          type: string
          description: Resource or Instance name
        networkid:
          type: string
          description: ID of the Network
        offeringid:
          type: string
          description: Offering ID
        oscategoryid:
          type: string
          description: Instance guest os category ID
        oscategoryname:
          type: string
          description: Instance os category name
        osdisplayname:
          type: string
          description: Instance os display name
        ostypeid:
          type: string
          description: Instance os type ID
        project:
          type: string
          description: The project name of the resource
        projectid:
          type: string
          description: The project ID of the resource
        rawusage:
          type: string
          description: Raw usage in hours
        size:
          type: integer
          format: int64
          description: Resource size
        startdate:
          type: string
          x-cloudstack-type: date
          description: Start date of the usage record. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        templateid:
          type: string
          description: Template ID
        type:
          type: string
          description: Resource type
        usage:
          type: string
          description: Usage in hours
        usageid:
          type: string
          description: ID of the resource
        usagetype:
          type: integer
          format: int32
          description: Usage type ID
        virtualmachineid:
          type: string
          description: Instance ID
        virtualsize:
          type: integer
          format: int64
          description: Virtual size of resource
        vpcid:
          type: string
          description: ID of the VPC
        zoneid:
          type: string
          description: The zone ID
    UsageServerMetric:
      type: object
      properties:
        collectiontime:
          type: string
          x-cloudstack-type: date
          description: The time these statistics were collected. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        hostname:
          type: string
          description: The name of the active usage server
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastheartbeat:
          type: string
          x-cloudstack-type: date
          description: The last time this Usage Server checked for jobs. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        lastsuccessfuljob:
          type: string
          x-cloudstack-type: date
          description: The last time a usage job successfully completed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        state:
          type: string
          x-cloudstack-type: state
          description: The state of the usage server
    UsageType:
      type: object
      properties:
        description:
          type: string
          description: Usage type description
        id:
          type: integer
          format: int32
          description: Usage type ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Usage type name
    User:
      type: object
      properties:
        account:
          type: string
          description: The Account name of the user
        accountid:
          type: string
          description: The Account ID of the user
        accounttype:
          type: integer
          format: int32
          description: The Account type of the user
        apikey:
          type: string
          description: The API key of the user
        apikeyaccess:
          type: string
          x-cloudstack-type: apikeyaccess
          description: Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the user Account was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: The domain name of the user
        domainid:
          type: string
          description: The domain ID of the user
        email:
          type: string
          description: The user email address
        firstname:
          type: string
          description: The user firstname
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The user ID
        is2faenabled:
          type: boolean
          description: True if user has two factor authentication enabled
        is2famandated:
          type: boolean
          description: True if user has two factor authentication is mandated
        iscallerchilddomain:
          type: boolean
          description: The boolean value representing if the updating target is in caller's child domain
        isdefault:
          type: boolean
          description: True if user is default, false otherwise
        lastname:
          type: string
          description: The user lastname
        roleid:
          type: string
          description: The ID of the role
        rolename:
          type: string
          description: The name of the role
        roletype:
          type: string
          description: The type of the role
        secretkey:
          type: string
          description: The secret key of the user
        state:
          type: string
          description: The user state
        timezone:
          type: string
          description: The timezone user was created in
        username:
          type: string
          description: The user name
        usersource:
          type: string
          description: The source type of the user in lowercase, such as native, ldap, saml2
    User2:
      type: object
      properties:
        account:
          type: string
          description: The Account name of the user
        accountid:
          type: string
          description: The Account ID of the user
        accounttype:
          type: integer
          format: int32
          description: The Account type of the user
        apikey:
          type: string
          description: The API key of the user
        apikeyaccess:
          type: string
          x-cloudstack-type: apikeyaccess
          description: Whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the user Account was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: The domain name of the user
        domainid:
          type: string
          description: The domain ID of the user
        email:
          type: string
          description: The user email address
        firstname:
          type: string
          description: The user firstname
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The user ID
        is2faenabled:
          type: boolean
          description: True if user has two factor authentication enabled
        is2famandated:
          type: boolean
          description: True if user has two factor authentication is mandated
        iscallerchilddomain:
          type: boolean
          description: The boolean value representing if the updating target is in caller's child domain
        isdefault:
          type: boolean
          description: True if user is default, false otherwise
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        lastname:
          type: string
          description: The user lastname
        roleid:
          type: string
          description: The ID of the role
        rolename:
          type: string
          description: The name of the role
        roletype:
          type: string
          description: The type of the role
        secretkey:
          type: string
          description: The secret key of the user
        state:
          type: string
          description: The user state
        timezone:
          type: string
          description: The timezone user was created in
        username:
          type: string
          description: The user name
        usersource:
          type: string
          description: The source type of the user in lowercase, such as native, ldap, saml2
    UserKey:
      type: object
      properties:
        apikey:
          type: string
          description: The API key of the registered user
        apikeyaccess:
          type: boolean
          description: Whether API key access is allowed or not
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        secretkey:
          type: string
          description: The secret key of the registered user
    UserKey2:
      type: object
      properties:
        accountid:
          type: string
          description: Account ID.
        accountname:
          type: string
          description: Account name.
        accounttype:
          type: string
          description: Account type.
        apikey:
          type: string
          description: The API key of the registered user.
        created:
          type: string
          x-cloudstack-type: date
          description: API key pair creation timestamp. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: API key pair description.
        domain:
          type: string
          description: Name of the domain which the account belongs to.
        domainid:
          type: string
          description: ID of the domain which the account belongs to.
        domainpath:
          type: string
          description: Path of the domain which the account belongs to.
        enddate:
          type: string
          x-cloudstack-type: date
          description: API key pair expiration date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: ID of the API key pair.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the API key pair
        permissions:
          type: array
          items: {}
          x-cloudstack-type: list
          description: Permissions of the API key pair.
        roleid:
          type: string
          description: ID of the role.
        rolename:
          type: string
          description: Name of the role.
        roletype:
          type: string
          description: Type of the role (Admin, ResourceAdmin, DomainAdmin, User).
        secretkey:
          type: string
          description: The secret key of the registered user.
        startdate:
          type: string
          x-cloudstack-type: date
          description: API key pair start date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        state:
          type: string
          x-cloudstack-type: apikeypairstate
          description: State of the API key pair.
        userid:
          type: string
          description: ID of the user that owns the keypair.
        username:
          type: string
          description: Username of the keypair's owner.
    UserKeyRule:
      type: object
      properties:
        description:
          type: string
          description: The description of the role permission
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        permission:
          type: string
          description: The permission type of the api name or wildcard rule, allow/deny
        rule:
          type: string
          description: The api name or wildcard rule
    VMPassword:
      type: object
      properties:
        encryptedpassword:
          type: string
          description: The base64 encoded encrypted password of the Instance
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
    VMSchedule:
      type: object
      properties:
        action:
          type: string
          x-cloudstack-type: action
          description: Action
        created:
          type: string
          x-cloudstack-type: date
          description: Date when the schedule was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: Description of Instance schedule
        enabled:
          type: boolean
          description: VM schedule is enabled
        enddate:
          type: string
          x-cloudstack-type: date
          description: Date after which the schedule becomes inactive. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        id:
          type: string
          description: The ID of Instance schedule
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        schedule:
          type: string
          description: Cron formatted Instance schedule
        startdate:
          type: string
          x-cloudstack-type: date
          description: Date from which the schedule is active. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        timezone:
          type: string
          description: Timezone of the schedule
        virtualmachineid:
          type: string
          description: ID of Instance
    VMSnapshot:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the disk volume
        created:
          type: string
          x-cloudstack-type: date
          description: The create date of the Instance Snapshot. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        current:
          type: boolean
          description: Indicates if this is current Snapshot
        description:
          type: string
          description: The description of the Instance Snapshot
        displayname:
          type: string
          description: The display name of the Instance Snapshot
        domain:
          type: string
          description: The domain associated with the disk volume
        domainid:
          type: string
          description: The ID of the domain associated with the disk volume
        domainpath:
          type: string
          description: Path of the domain to which the disk volume belongs
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hypervisor:
          type: string
          description: The type of hypervisor on which Snapshot is stored
        id:
          type: string
          description: The ID of the Instance Snapshot
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the Instance Snapshot
        parent:
          type: string
          description: The parent ID of the Instance Snapshot
        parentName:
          type: string
          description: The parent displayName of the Instance Snapshot
        project:
          type: string
          description: The project name of the VPN
        projectid:
          type: string
          description: The project ID of the VPN
        state:
          type: string
          x-cloudstack-type: state
          description: The state of the Instance Snapshot
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        type:
          type: string
          description: Instance Snapshot type
        virtualmachineid:
          type: string
          description: The Instance ID of the Instance Snapshot
        virtualmachinename:
          type: string
          description: The Instance name of the Instance Snapshot
        zoneid:
          type: string
          description: The Zone ID of the Instance Snapshot
        zonename:
          type: string
          description: The Zone name of the Instance Snapshot
    VPC:
      type: object
      properties:
        account:
          type: string
          description: The owner of the VPC
        asnumber:
          type: integer
          format: int64
          description: AS NUMBER
        asnumberid:
          type: string
          description: UUID of AS NUMBER
        bgppeers:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The BGP peers for the VPC
        cidr:
          type: string
          description: The CIDR the VPC
        created:
          type: string
          x-cloudstack-type: date
          description: The date this VPC was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        displaytext:
          type: string
          description: An alternate display text of the VPC.
        distributedvpcrouter:
          type: boolean
          description: Does VPC use distributed router for one hop forwarding and host based Network ACL's
        dns1:
          type: string
          description: The first IPv4 DNS for the VPC
        dns2:
          type: string
          description: The second IPv4 DNS for the VPC
        domain:
          type: string
          description: The domain name of the owner
        domainid:
          type: string
          description: The domain ID of the VPC owner
        domainpath:
          type: string
          description: The domain path of the owner
        fordisplay:
          type: boolean
          description: Is VPC for display to the regular user
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The ID of the VPC
        ip4routes:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The routes for the VPC to ease adding route in upstream router
        ip4routing:
          type: string
          description: The IPv4 routing mode of VPC
        ip6dns1:
          type: string
          description: The first IPv6 DNS for the VPC
        ip6dns2:
          type: string
          description: The second IPv6 DNS for the VPC
        ip6routes:
          type: array
          items: {}
          x-cloudstack-type: set
          description: The routes for the Network to ease adding route in upstream router
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        keepmacaddressonpublicnic:
          type: boolean
          description: Indicates whether to use the same MAC address for the public NIC of VRs on the same network. If "true", when creating redundant routers or recreating a VR, CloudStack will use the same MAC address for the public NIC of all VRs. Otherwise, if "false", new public NICs will always have  a new MAC address.
        name:
          type: string
          description: The name of the VPC
        network:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of Networks belonging to the VPC
        networkdomain:
          type: string
          description: The Network domain of the VPC
        project:
          type: string
          description: The project name of the VPC
        projectid:
          type: string
          description: The project ID of the VPC
        publicmtu:
          type: integer
          format: int32
          description: MTU configured on the public interfaces of the VPC VR
        redundantvpcrouter:
          type: boolean
          description: If this VPC has redundant router
        regionlevelvpc:
          type: boolean
          description: True if VPC is region level
        restartrequired:
          type: boolean
          description: True VPC requires restart
        service:
          type: array
          items:
            $ref: '#/components/schemas/Service'
          x-cloudstack-type: list
          description: The list of supported services
        state:
          type: string
          description: State of the VPC. Can be Inactive/Enabled
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: list
          description: The list of resource tags associated with the project
        vpcofferingconservemode:
          type: boolean
          description: true if VPC offering is ip conserve mode enabled
        vpcofferingid:
          type: string
          description: VPC offering ID the VPC is created from
        vpcofferingname:
          type: string
          description: VPC offering name the VPC is created from
        zoneid:
          type: string
          description: Zone ID of the VPC
        zonename:
          type: string
          description: The name of the zone the VPC belongs to
    VPCOffering:
      type: object
      properties:
        conservemode:
          type: boolean
          description: True if the VPC offering is IP conserve mode enabled, allowing public IP services to be used across multiple VPC tiers.
        created:
          type: string
          x-cloudstack-type: date
          description: The date this VPC offering was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        displaytext:
          type: string
          description: An alternate display text of the VPC offering.
        distributedvpcrouter:
          type: boolean
          description: Indicates if the VPC offering supports distributed router for one-hop forwarding
        domain:
          type: string
          description: The domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        domainid:
          type: string
          description: The domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        fornsx:
          type: boolean
          description: True if VPC offering can be used by NSX networks only
        id:
          type: string
          description: The ID of the VPC offering
        internetprotocol:
          type: string
          description: The internet protocol of the VPC offering
        isdefault:
          type: boolean
          description: True if VPC offering is default, false otherwise
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the VPC offering
        networkmode:
          type: string
          description: Mode in which the network will operate. The valid values are NATTED and ROUTED
        routingmode:
          type: string
          description: The routing mode for the network offering, supported types are Static or Dynamic.
        service:
          type: array
          items:
            $ref: '#/components/schemas/Service'
          x-cloudstack-type: list
          description: The list of supported services
        specifyasnumber:
          type: boolean
          description: True if network offering supports choosing AS numbers
        state:
          type: string
          description: State of the VPC offering. Can be Disabled/Enabled
        supportsregionLevelvpc:
          type: boolean
          description: Indicated if the offering can support region level VPC
        zone:
          type: string
          description: The zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
        zoneid:
          type: string
          description: The zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.
    Vgpu:
      type: object
      properties:
        maxcapacity:
          type: integer
          format: int64
          description: Maximum vGPU can be created with this vGPU type on the given GPU group
        maxheads:
          type: integer
          format: int64
          description: Maximum displays per user
        maxresolutionx:
          type: integer
          format: int64
          description: Maximum X resolution per display
        maxresolutiony:
          type: integer
          format: int64
          description: Maximum Y resolution per display
        maxvgpuperpgpu:
          type: integer
          format: int64
          description: Maximum no. of vGPU per GPU card (pgpu)
        remainingcapacity:
          type: integer
          format: int64
          description: Remaining capacity in terms of no. of more Instances that can be deployed with this vGPU type
        vgputype:
          type: string
          description: Model Name of vGPU
        videoram:
          type: integer
          format: int64
          description: Video RAM for this vGPU type
    VgpuProfile:
      type: object
      properties:
        description:
          type: string
          description: the description of the vGPU profile
        deviceid:
          type: string
          description: the device ID of the GPU card
        devicename:
          type: string
          description: the device name of the GPU card
        gpucardid:
          type: string
          description: the ID of the GPU card associated with this vGPU profile
        gpucardname:
          type: string
          description: the name of the vGPU profile
        id:
          type: string
          description: the ID of the GPU card
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        maxheads:
          type: integer
          format: int64
          description: the maximum number of display heads
        maxresolutionx:
          type: integer
          format: int64
          description: the maximum X resolution
        maxresolutiony:
          type: integer
          format: int64
          description: the maximum Y resolution
        maxvgpuperphysicalgpu:
          type: integer
          format: int64
          description: the maximum number of vGPUs per physical GPU
        name:
          type: string
          description: the display name of the GPU card
        vendorid:
          type: string
          description: the vendor ID of the GPU card
        vendorname:
          type: string
          description: the vendor name of the GPU card
        videoram:
          type: integer
          format: int64
          description: the video RAM size in MB
    VirtualMachine:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the Instance
        affinitygroup:
          type: array
          items:
            $ref: '#/components/schemas/Affinitygroup'
          x-cloudstack-type: set
          description: List of Affinity groups associated with the Instance
        alloweddetails:
          type: string
          description: List of allowed Vm details as comma separated string if VM instance settings are read from OVA.
        arch:
          type: string
          description: CPU arch of the VM
        autoscalevmgroupid:
          type: string
          description: ID of AutoScale Instance group
        autoscalevmgroupname:
          type: string
          description: Name of AutoScale Instance group
        backupofferingid:
          type: string
          description: The ID of the backup offering of the Instance
        backupofferingname:
          type: string
          description: The name of the backup offering of the Instance
        backupprovider:
          type: string
          description: The name of the backup provider of the offering attached to the Instance
        bootmode:
          type: string
          description: Guest Instance Boot Mode
        boottype:
          type: string
          description: Guest Instance Boot Type
        cpunumber:
          type: integer
          format: int32
          description: The number of vCPUs this Instance is using
        cpuspeed:
          type: integer
          format: int32
          description: The speed of each vCPU
        cpuused:
          type: string
          description: The amount of the Instance's CPU currently used
        created:
          type: string
          x-cloudstack-type: date
          description: The date when this Instance was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        deleteprotection:
          type: boolean
          description: true if vm has delete protection.
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Instance details in key/value pairs.
        diskioread:
          type: integer
          format: int64
          description: The read (IO) of disk on the Instance
        diskiowrite:
          type: integer
          format: int64
          description: The write (IO) of disk on the Instance
        diskkbsread:
          type: integer
          format: int64
          description: The Instance's disk read in KiB
        diskkbswrite:
          type: integer
          format: int64
          description: The Instance's disk write in KiB
        diskofferingid:
          type: string
          description: The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
        diskofferingname:
          type: string
          description: The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
        displayname:
          type: string
          description: User generated name. The name of the Instance is returned if no displayname exists.
        displayvm:
          type: boolean
          description: An optional field whether to the display the Instance to the end user or not.
        domain:
          type: string
          description: The name of the domain in which the Instance exists
        domainid:
          type: string
          description: The ID of the domain in which the Instance exists
        domainpath:
          type: string
          description: Path of the domain in which the virtual machine exists
        forvirtualnetwork:
          type: boolean
          description: The virtual Network for the service offering
        gpucardid:
          type: string
          description: the ID of the gpu card to which service offering is linked
        gpucardname:
          type: string
          description: the name of the gpu card to which service offering is linked
        gpucount:
          type: integer
          format: int32
          description: the count of GPUs on the virtual machine
        group:
          type: string
          description: The group name of the Instance
        groupid:
          type: string
          description: The group ID of the Instance
        guestosid:
          type: string
          description: OS type ID of the Instance
        haenable:
          type: boolean
          description: True if high-availability is enabled, false otherwise
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hostcontrolstate:
          type: string
          description: The control state of the host for the Instance
        hostid:
          type: string
          description: The ID of the host for the Instance
        hostname:
          type: string
          description: The name of the host for the Instance
        hypervisor:
          type: string
          description: The hypervisor on which the Template runs
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The ID of the Instance
        instancename:
          type: string
          description: Instance name of the user Instance; this parameter is returned to the ROOT admin only
        ipaddress:
          type: string
          description: the VM's primary IP address
        isdynamicallyscalable:
          type: boolean
          description: True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
        isodisplaytext:
          type: string
          description: An alternate display text of the ISO attached to the Instance
        isoid:
          type: string
          description: The ID of the ISO attached to the Instance
        isomaxcount:
          type: integer
          format: int32
          description: Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
        isoname:
          type: string
          description: The name of the ISO attached to the Instance
        isos:
          type: array
          items:
            $ref: '#/components/schemas/Isos'
          x-cloudstack-type: list
          description: All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        keypairs:
          type: string
          description: SSH key-pairs
        lastupdated:
          type: string
          x-cloudstack-type: date
          description: The date when this Instance was updated last time. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        leaseduration:
          type: integer
          format: int32
          description: Instance lease duration in days
        leaseexpiryaction:
          type: string
          description: Instance lease expiry action
        leaseexpirydate:
          type: string
          x-cloudstack-type: date
          description: Instance lease expiry date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        maxheads:
          type: integer
          format: int64
          description: the maximum number of display heads
        maxresolutionx:
          type: integer
          format: int64
          description: the maximum X resolution
        maxresolutiony:
          type: integer
          format: int64
          description: the maximum Y resolution
        memory:
          type: integer
          format: int32
          description: The memory allocated for the Instance
        memoryintfreekbs:
          type: integer
          format: int64
          description: The internal memory (KiB) that's free in Instance or zero if it can not be calculated
        memorykbs:
          type: integer
          format: int64
          description: The memory used by the Instance in KiB
        memorytargetkbs:
          type: integer
          format: int64
          description: The target memory in Instance (KiB)
        name:
          type: string
          description: The name of the Instance
        networkkbsread:
          type: integer
          format: int64
          description: The incoming Network traffic on the Instance in KiB
        networkkbswrite:
          type: integer
          format: int64
          description: The outgoing Network traffic on the host in KiB
        nic:
          type: array
          items:
            $ref: '#/components/schemas/Nic'
          x-cloudstack-type: set
          description: The list of NICs associated with Instance
        osdisplayname:
          type: string
          description: OS name of the Instance
        ostypeid:
          type: string
          description: OS type id of the Instance
        password:
          type: string
          description: The password (if exists) of the Instance
        passwordenabled:
          type: boolean
          description: True if the password rest feature is enabled, false otherwise
        pooltype:
          type: string
          description: The pool type of the Instance
        project:
          type: string
          description: The project name of the Instance
        projectid:
          type: string
          description: The project ID of the Instance
        publicip:
          type: string
          description: Public IP address id associated with Instance via Static NAT rule
        publicipid:
          type: string
          description: Public IP address id associated with Instance via Static NAT rule
        readonlydetails:
          type: string
          description: List of read-only Instance details as comma separated string.
        receivedbytes:
          type: integer
          format: int64
          description: The total number of Network traffic bytes received
        rootdeviceid:
          type: integer
          format: int64
          description: Device ID of the root volume
        rootdevicetype:
          type: string
          description: Device type of the root volume
        securitygroup:
          type: array
          items:
            $ref: '#/components/schemas/Securitygroup'
          x-cloudstack-type: set
          description: List of security groups associated with the Instance
        sentbytes:
          type: integer
          format: int64
          description: The total number of Network traffic bytes sent
        serviceofferingid:
          type: string
          description: The ID of the service offering of the Instance
        serviceofferingname:
          type: string
          description: The name of the service offering of the Instance
        servicestate:
          type: string
          description: State of the Service from LB rule
        state:
          type: string
          description: The state of the Instance
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        templatedisplaytext:
          type: string
          description: An alternate display text of the Template for the Instance
        templateformat:
          type: string
          description: The format of the template for the virtual machine
        templateid:
          type: string
          description: The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
        templatename:
          type: string
          description: The name of the Template for the Instance
        templatetype:
          type: string
          description: The type of the template for the virtual machine
        userdata:
          type: string
          description: Base64 string containing the user data
        userdatadetails:
          type: string
          description: List of variables and values for the variables declared in userdata
        userdataid:
          type: string
          description: The ID of userdata used for the Instance
        userdataname:
          type: string
          description: The name of userdata used for the Instance
        userdatapolicy:
          type: string
          description: The userdata override policy with the userdata provided while deploying Instance
        userid:
          type: string
          description: The User's ID who deployed the Instance
        username:
          type: string
          description: The User's name who deployed the Instance
        vgpu:
          type: string
          description: The vGPU type used by the Instance
        vgpuprofileid:
          type: string
          description: the ID of the vgpu profile to which service offering is linked
        vgpuprofilename:
          type: string
          description: the name of the vgpu profile to which service offering is linked
        videoram:
          type: integer
          format: int64
          description: the video RAM size in MB
        vmtype:
          type: string
          description: User VM type
        vnfdetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: VNF details
        vnfnics:
          type: array
          items: {}
          x-cloudstack-type: list
          description: NICs of the VNF appliance
        zoneid:
          type: string
          description: The ID of the availability zone for the Instance
        zonename:
          type: string
          description: The name of the availability zone for the Instance
    VirtualMachine2:
      type: object
      properties:
        details:
          type: string
          description: Details of the unmanage Instance operation
        hostid:
          type: string
          description: The ID of the host used for unmanaged Instance
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        success:
          type: boolean
          description: Result of the unmanage Instance operation
    VirtualMachineUserData:
      type: object
      properties:
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        userdata:
          type: string
          description: Base64 encoded Instance User Data
        virtualmachineid:
          type: string
          description: The ID of the Instance
    VirtualMachinesFromKubernetesCluster:
      type: object
      properties:
        displaytext:
          type: string
          description: Any text associated with the success or failure
        id:
          type: string
          description: The ID of the Kubernetes cluster
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        success:
          type: boolean
          description: True if operation is executed successfully
    VirtualMachinesMetric:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the Instance
        affinitygroup:
          type: array
          items:
            $ref: '#/components/schemas/Affinitygroup'
          x-cloudstack-type: set
          description: List of Affinity groups associated with the Instance
        alloweddetails:
          type: string
          description: List of allowed Vm details as comma separated string if VM instance settings are read from OVA.
        arch:
          type: string
          description: CPU arch of the VM
        autoscalevmgroupid:
          type: string
          description: ID of AutoScale Instance group
        autoscalevmgroupname:
          type: string
          description: Name of AutoScale Instance group
        backupofferingid:
          type: string
          description: The ID of the backup offering of the Instance
        backupofferingname:
          type: string
          description: The name of the backup offering of the Instance
        backupprovider:
          type: string
          description: The name of the backup provider of the offering attached to the Instance
        bootmode:
          type: string
          description: Guest Instance Boot Mode
        boottype:
          type: string
          description: Guest Instance Boot Type
        cpunumber:
          type: integer
          format: int32
          description: The number of vCPUs this Instance is using
        cpuspeed:
          type: integer
          format: int32
          description: The speed of each vCPU
        cputotal:
          type: string
          description: The total cpu capacity in Ghz
        cpuused:
          type: string
          description: The amount of the Instance's CPU currently used
        created:
          type: string
          x-cloudstack-type: date
          description: The date when this Instance was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        deleteprotection:
          type: boolean
          description: true if vm has delete protection.
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Instance details in key/value pairs.
        diskiopstotal:
          type: integer
          format: int64
          description: The total disk iops
        diskioread:
          type: integer
          format: int64
          description: The read (IO) of disk on the Instance
        diskiowrite:
          type: integer
          format: int64
          description: The write (IO) of disk on the Instance
        diskkbsread:
          type: integer
          format: int64
          description: The Instance's disk read in KiB
        diskkbswrite:
          type: integer
          format: int64
          description: The Instance's disk write in KiB
        diskofferingid:
          type: string
          description: The ID of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
        diskofferingname:
          type: string
          description: The name of the disk offering of the Instance. This parameter should not be used for retrieving disk offering details of DATA volumes. Use listVolumes API instead
        diskread:
          type: string
          description: Disk read in MiB
        diskwrite:
          type: string
          description: Disk write in MiB
        displayname:
          type: string
          description: User generated name. The name of the Instance is returned if no displayname exists.
        displayvm:
          type: boolean
          description: An optional field whether to the display the Instance to the end user or not.
        domain:
          type: string
          description: The name of the domain in which the Instance exists
        domainid:
          type: string
          description: The ID of the domain in which the Instance exists
        domainpath:
          type: string
          description: Path of the domain in which the virtual machine exists
        forvirtualnetwork:
          type: boolean
          description: The virtual Network for the service offering
        gpucardid:
          type: string
          description: the ID of the gpu card to which service offering is linked
        gpucardname:
          type: string
          description: the name of the gpu card to which service offering is linked
        gpucount:
          type: integer
          format: int32
          description: the count of GPUs on the virtual machine
        group:
          type: string
          description: The group name of the Instance
        groupid:
          type: string
          description: The group ID of the Instance
        guestosid:
          type: string
          description: OS type ID of the Instance
        haenable:
          type: boolean
          description: True if high-availability is enabled, false otherwise
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hostcontrolstate:
          type: string
          description: The control state of the host for the Instance
        hostid:
          type: string
          description: The ID of the host for the Instance
        hostname:
          type: string
          description: The name of the host for the Instance
        hypervisor:
          type: string
          description: The hypervisor on which the Template runs
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: The ID of the Instance
        instancename:
          type: string
          description: Instance name of the user Instance; this parameter is returned to the ROOT admin only
        ipaddress:
          type: string
          description: the VM's primary IP address
        isdynamicallyscalable:
          type: boolean
          description: True if Instance contains XS/VMWare tools in order to support dynamic scaling of Instance CPU/memory.
        isodisplaytext:
          type: string
          description: An alternate display text of the ISO attached to the Instance
        isoid:
          type: string
          description: The ID of the ISO attached to the Instance
        isomaxcount:
          type: integer
          format: int32
          description: Maximum number of ISOs that may be attached to this Instance, after applying the cluster-scoped vm.iso.max.count and the hypervisor's own cap.
        isoname:
          type: string
          description: The name of the ISO attached to the Instance
        isos:
          type: array
          items:
            $ref: '#/components/schemas/Isos'
          x-cloudstack-type: list
          description: All ISOs attached to the Instance, keyed by cdrom slot. The first entry mirrors isoid/isoname for back-compat.
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        keypairs:
          type: string
          description: SSH key-pairs
        lastupdated:
          type: string
          x-cloudstack-type: date
          description: The date when this Instance was updated last time. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        leaseduration:
          type: integer
          format: int32
          description: Instance lease duration in days
        leaseexpiryaction:
          type: string
          description: Instance lease expiry action
        leaseexpirydate:
          type: string
          x-cloudstack-type: date
          description: Instance lease expiry date. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        maxheads:
          type: integer
          format: int64
          description: the maximum number of display heads
        maxresolutionx:
          type: integer
          format: int64
          description: the maximum X resolution
        maxresolutiony:
          type: integer
          format: int64
          description: the maximum Y resolution
        memory:
          type: integer
          format: int32
          description: The memory allocated for the Instance
        memoryintfreekbs:
          type: integer
          format: int64
          description: The internal memory (KiB) that's free in Instance or zero if it can not be calculated
        memorykbs:
          type: integer
          format: int64
          description: The memory used by the Instance in KiB
        memorytargetkbs:
          type: integer
          format: int64
          description: The target memory in Instance (KiB)
        memorytotal:
          type: string
          description: The total memory capacity in GiB
        name:
          type: string
          description: The name of the Instance
        networkkbsread:
          type: integer
          format: int64
          description: The incoming Network traffic on the Instance in KiB
        networkkbswrite:
          type: integer
          format: int64
          description: The outgoing Network traffic on the host in KiB
        networkread:
          type: string
          description: Network read in MiB
        networkwrite:
          type: string
          description: Network write in MiB
        nic:
          type: array
          items:
            $ref: '#/components/schemas/Nic'
          x-cloudstack-type: set
          description: The list of NICs associated with Instance
        osdisplayname:
          type: string
          description: OS name of the Instance
        ostypeid:
          type: string
          description: OS type id of the Instance
        password:
          type: string
          description: The password (if exists) of the Instance
        passwordenabled:
          type: boolean
          description: True if the password rest feature is enabled, false otherwise
        pooltype:
          type: string
          description: The pool type of the Instance
        project:
          type: string
          description: The project name of the Instance
        projectid:
          type: string
          description: The project ID of the Instance
        publicip:
          type: string
          description: Public IP address id associated with Instance via Static NAT rule
        publicipid:
          type: string
          description: Public IP address id associated with Instance via Static NAT rule
        readonlydetails:
          type: string
          description: List of read-only Instance details as comma separated string.
        receivedbytes:
          type: integer
          format: int64
          description: The total number of Network traffic bytes received
        rootdeviceid:
          type: integer
          format: int64
          description: Device ID of the root volume
        rootdevicetype:
          type: string
          description: Device type of the root volume
        securitygroup:
          type: array
          items:
            $ref: '#/components/schemas/Securitygroup'
          x-cloudstack-type: set
          description: List of security groups associated with the Instance
        sentbytes:
          type: integer
          format: int64
          description: The total number of Network traffic bytes sent
        serviceofferingid:
          type: string
          description: The ID of the service offering of the Instance
        serviceofferingname:
          type: string
          description: The name of the service offering of the Instance
        servicestate:
          type: string
          description: State of the Service from LB rule
        state:
          type: string
          description: The state of the Instance
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        templatedisplaytext:
          type: string
          description: An alternate display text of the Template for the Instance
        templateformat:
          type: string
          description: The format of the template for the virtual machine
        templateid:
          type: string
          description: The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
        templatename:
          type: string
          description: The name of the Template for the Instance
        templatetype:
          type: string
          description: The type of the template for the virtual machine
        userdata:
          type: string
          description: Base64 string containing the user data
        userdatadetails:
          type: string
          description: List of variables and values for the variables declared in userdata
        userdataid:
          type: string
          description: The ID of userdata used for the Instance
        userdataname:
          type: string
          description: The name of userdata used for the Instance
        userdatapolicy:
          type: string
          description: The userdata override policy with the userdata provided while deploying Instance
        userid:
          type: string
          description: The User's ID who deployed the Instance
        username:
          type: string
          description: The User's name who deployed the Instance
        vgpu:
          type: string
          description: The vGPU type used by the Instance
        vgpuprofileid:
          type: string
          description: the ID of the vgpu profile to which service offering is linked
        vgpuprofilename:
          type: string
          description: the name of the vgpu profile to which service offering is linked
        videoram:
          type: integer
          format: int64
          description: the video RAM size in MB
        vmtype:
          type: string
          description: User VM type
        vnfdetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: VNF details
        vnfnics:
          type: array
          items: {}
          x-cloudstack-type: list
          description: NICs of the VNF appliance
        zoneid:
          type: string
          description: The ID of the availability zone for the Instance
        zonename:
          type: string
          description: The name of the availability zone for the Instance
    VirtualRouterElement:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the provider
        domain:
          type: string
          description: The domain associated with the provider
        domainid:
          type: string
          description: The domain ID associated with the provider
        domainpath:
          type: string
          description: Path of the domain to which the provider belongs
        enabled:
          type: boolean
          description: Enabled/Disabled the service provider
        id:
          type: string
          description: The ID of the ovs
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        nspid:
          type: string
          description: The physical Network service provider id of the provider
        project:
          type: string
          description: The project name of the address
        projectid:
          type: string
          description: The project ID of the IP address
    VlanIpRange:
      type: object
      properties:
        account:
          type: string
          description: The Account of the VLAN IP range
        cidr:
          type: string
          description: The CIDR of the VLAN IP range
        description:
          type: string
          description: The description of the VLAN IP range
        domain:
          type: string
          description: The domain name of the VLAN IP range
        domainid:
          type: string
          description: The domain ID of the VLAN IP range
        domainpath:
          type: string
          description: Path of the domain to which the VLAN IP range belongs
        endip:
          type: string
          description: The end IP of the VLAN IP range
        endipv6:
          type: string
          description: The end IPv6 of the VLAN IP range
        forsystemvms:
          type: boolean
          description: Indicates whether VLAN IP range is dedicated to System VMs or not
        forvirtualnetwork:
          type: boolean
          description: The virtual Network for the VLAN IP range
        gateway:
          type: string
          description: The gateway of the VLAN IP range
        id:
          type: string
          description: The ID of the VLAN IP range
        ip6cidr:
          type: string
          description: The CIDR of IPv6 Network
        ip6gateway:
          type: string
          description: The gateway of IPv6 Network
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        netmask:
          type: string
          description: The netmask of the VLAN IP range
        networkid:
          type: string
          description: The Network ID of VLAN range
        physicalnetworkid:
          type: string
          description: The physical Network this belongs to
        podid:
          type: string
          description: The Pod ID for the VLAN IP range
        podname:
          type: string
          description: The Pod name for the VLAN IP range
        project:
          type: string
          description: The project name of the VLAN range
        projectid:
          type: string
          description: The project ID of the VLAN range
        provider:
          type: string
          description: indicates to which provider the IP range is dedicated to
        startip:
          type: string
          description: The start IP of the VLAN IP range
        startipv6:
          type: string
          description: The start IPv6 of the VLAN IP range
        vlan:
          type: string
          description: The ID or VID of the VLAN.
        zoneid:
          type: string
          description: The Zone ID of the VLAN IP range
    VmwareDc:
      type: object
      properties:
        id:
          type: string
          description: The VMware Datacenter ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The VMware Datacenter name
        vcenter:
          type: string
          description: The VMware vCenter name/ip
        zoneid:
          type: integer
          format: int64
          description: The Zone ID associated with this VMware Datacenter
    Volume:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the disk volume
        attached:
          type: string
          x-cloudstack-type: date
          description: The date the volume was attached to an Instance. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        chaininfo:
          type: string
          description: The chain info of the volume
        clusterid:
          type: string
          description: Cluster id of the volume
        clustername:
          type: string
          description: Cluster name where the volume is allocated
        created:
          type: string
          x-cloudstack-type: date
          description: The date the disk volume was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        deleteprotection:
          type: boolean
          description: true if volume has delete protection.
        destroyed:
          type: boolean
          description: The boolean state of whether the volume is destroyed or not
        deviceid:
          type: integer
          format: int64
          description: The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
        diskBytesReadRate:
          type: integer
          format: int64
          description: Bytes read rate of the disk volume
        diskBytesWriteRate:
          type: integer
          format: int64
          description: Bytes write rate of the disk volume
        diskIopsReadRate:
          type: integer
          format: int64
          description: IO requests read rate of the disk volume per the disk offering
        diskIopsWriteRate:
          type: integer
          format: int64
          description: IO requests write rate of the disk volume per the disk offering
        diskioread:
          type: integer
          format: int64
          description: The read (IO) of disk on the Instance
        diskiowrite:
          type: integer
          format: int64
          description: The write (IO) of disk on the Instance
        diskkbsread:
          type: integer
          format: int64
          description: The Instance's disk read in KiB
        diskkbswrite:
          type: integer
          format: int64
          description: The Instance's disk write in KiB
        diskofferingdisplaytext:
          type: string
          description: The display text of the disk offering
        diskofferingid:
          type: string
          description: ID of the disk offering
        diskofferingname:
          type: string
          description: Name of the disk offering
        displayvolume:
          type: boolean
          description: An optional field whether to the display the volume to the end User or not.
        domain:
          type: string
          description: The domain associated with the disk volume
        domainid:
          type: string
          description: The ID of the domain associated with the disk volume
        domainpath:
          type: string
          description: path of the Domain the disk volume belongs to
        encryptformat:
          type: string
          description: the format of the disk encryption if applicable
        externaluuid:
          type: string
          description: Volume UUID that is given by virtualisation provider (only for VMware)
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hypervisor:
          type: string
          description: Hypervisor the volume belongs to
        id:
          type: string
          description: ID of the disk volume
        isextractable:
          type: boolean
          description: True if the volume is extractable, false otherwise
        isodisplaytext:
          type: string
          description: An alternate display text of the ISO attached to the Instance
        isoid:
          type: string
          description: The ID of the ISO attached to the Instance
        isoname:
          type: string
          description: The name of the ISO attached to the Instance
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        kmskey:
          type: string
          description: KMS key name of the volume
        kmskeyid:
          type: string
          description: KMS key id of the volume
        kmskeyversion:
          type: integer
          format: int32
          description: Version number of the KMS key used for disk encryption if applicable
        maxiops:
          type: integer
          format: int64
          description: Max IOPS of the disk volume
        miniops:
          type: integer
          format: int64
          description: Min IOPS of the disk volume
        name:
          type: string
          description: Name of the disk volume
        path:
          type: string
          description: The path of the volume
        physicalsize:
          type: integer
          format: int64
          description: The bytes actually consumed on disk
        podid:
          type: string
          description: Pod id of the volume
        podname:
          type: string
          description: Pod name of the volume
        project:
          type: string
          description: The project name of the VPN
        projectid:
          type: string
          description: The project id of the VPN
        provisioningtype:
          type: string
          description: Provisioning type used to create volumes.
        quiescevm:
          type: boolean
          description: Need quiesce Instance or not when taking Snapshot
        serviceofferingdisplaytext:
          type: string
          description: The display text of the service offering for root disk
        serviceofferingid:
          type: string
          description: ID of the service offering for root disk
        serviceofferingname:
          type: string
          description: Name of the service offering for root disk
        size:
          type: integer
          format: int64
          description: Size of the disk volume
        snapshotid:
          type: string
          description: ID of the Snapshot from which this volume was created
        state:
          type: string
          description: The state of the disk volume
        status:
          type: string
          description: The status of the volume
        storage:
          type: string
          description: Name of the primary storage hosting the disk volume
        storageid:
          type: string
          description: ID of the primary storage hosting the disk volume; returned to admin User only
        storagetype:
          type: string
          description: Shared or local storage
        supportsstoragesnapshot:
          type: boolean
          description: True if storage Snapshot is supported for the volume, false otherwise
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        templatedisplaytext:
          type: string
          description: An alternate display text of the Template for the Instance
        templateid:
          type: string
          description: The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
        templatename:
          type: string
          description: The name of the Template for the Instance
        type:
          type: string
          description: Type of the disk volume (ROOT or DATADISK)
        utilization:
          type: string
          description: The disk utilization
        virtualmachineid:
          type: string
          description: ID of the Instance
        virtualsize:
          type: integer
          format: int64
          description: The bytes allocated
        vmdisplayname:
          type: string
          description: Display name of the Instance
        vmname:
          type: string
          description: Name of the Instance
        vmstate:
          type: string
          description: State of the Instance
        vmtype:
          type: string
          description: Type of the Instance
        volumecheckresult:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: details for the volume check result, they may vary for different hypervisors
        volumerepairresult:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: details for the volume repair result, they may vary for different hypervisors
        zoneid:
          type: string
          description: ID of the availability zone
        zonename:
          type: string
          description: Name of the availability zone
    VolumesForImport:
      type: object
      properties:
        chaininfo:
          type: string
          description: the chain info of the volume
        details:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: volume details in key/value pairs.
        encryptformat:
          type: string
          description: the encrypt format of the volume
        format:
          type: string
          description: the format of the volume
        fullpath:
          type: string
          description: the full path of the volume
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: the name of the volume
        path:
          type: string
          description: the path of the volume
        size:
          type: integer
          format: int64
          description: the size of the volume
        storage:
          type: string
          description: name of the primary storage hosting the volume
        storageid:
          type: string
          description: id of the primary storage hosting the volume
        storagetype:
          type: string
          description: type of the primary storage hosting the volume
        virtualsize:
          type: integer
          format: int64
          description: the virtual size of the volume
    VolumesMetric:
      type: object
      properties:
        account:
          type: string
          description: The Account associated with the disk volume
        attached:
          type: string
          x-cloudstack-type: date
          description: The date the volume was attached to an Instance. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        chaininfo:
          type: string
          description: The chain info of the volume
        clusterid:
          type: string
          description: Cluster id of the volume
        clustername:
          type: string
          description: Cluster name where the volume is allocated
        created:
          type: string
          x-cloudstack-type: date
          description: The date the disk volume was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        deleteprotection:
          type: boolean
          description: true if volume has delete protection.
        destroyed:
          type: boolean
          description: The boolean state of whether the volume is destroyed or not
        deviceid:
          type: integer
          format: int64
          description: The ID of the device on User Instance the volume is attached to. This tag is not returned when the volume is detached.
        diskBytesReadRate:
          type: integer
          format: int64
          description: Bytes read rate of the disk volume
        diskBytesWriteRate:
          type: integer
          format: int64
          description: Bytes write rate of the disk volume
        diskIopsReadRate:
          type: integer
          format: int64
          description: IO requests read rate of the disk volume per the disk offering
        diskIopsWriteRate:
          type: integer
          format: int64
          description: IO requests write rate of the disk volume per the disk offering
        diskiopstotal:
          type: integer
          format: int64
          description: The total disk iops
        diskioread:
          type: integer
          format: int64
          description: The read (IO) of disk on the Instance
        diskiowrite:
          type: integer
          format: int64
          description: The write (IO) of disk on the Instance
        diskkbsread:
          type: integer
          format: int64
          description: The Instance's disk read in KiB
        diskkbswrite:
          type: integer
          format: int64
          description: The Instance's disk write in KiB
        diskofferingdisplaytext:
          type: string
          description: The display text of the disk offering
        diskofferingid:
          type: string
          description: ID of the disk offering
        diskofferingname:
          type: string
          description: Name of the disk offering
        displayvolume:
          type: boolean
          description: An optional field whether to the display the volume to the end User or not.
        domain:
          type: string
          description: The domain associated with the disk volume
        domainid:
          type: string
          description: The ID of the domain associated with the disk volume
        domainpath:
          type: string
          description: path of the Domain the disk volume belongs to
        encryptformat:
          type: string
          description: the format of the disk encryption if applicable
        externaluuid:
          type: string
          description: Volume UUID that is given by virtualisation provider (only for VMware)
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        hypervisor:
          type: string
          description: Hypervisor the volume belongs to
        id:
          type: string
          description: ID of the disk volume
        isextractable:
          type: boolean
          description: True if the volume is extractable, false otherwise
        isodisplaytext:
          type: string
          description: An alternate display text of the ISO attached to the Instance
        isoid:
          type: string
          description: The ID of the ISO attached to the Instance
        isoname:
          type: string
          description: The name of the ISO attached to the Instance
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        kmskey:
          type: string
          description: KMS key name of the volume
        kmskeyid:
          type: string
          description: KMS key id of the volume
        kmskeyversion:
          type: integer
          format: int32
          description: Version number of the KMS key used for disk encryption if applicable
        maxiops:
          type: integer
          format: int64
          description: Max IOPS of the disk volume
        miniops:
          type: integer
          format: int64
          description: Min IOPS of the disk volume
        name:
          type: string
          description: Name of the disk volume
        path:
          type: string
          description: The path of the volume
        physicalsize:
          type: integer
          format: int64
          description: The bytes actually consumed on disk
        podid:
          type: string
          description: Pod id of the volume
        podname:
          type: string
          description: Pod name of the volume
        project:
          type: string
          description: The project name of the VPN
        projectid:
          type: string
          description: The project id of the VPN
        provisioningtype:
          type: string
          description: Provisioning type used to create volumes.
        quiescevm:
          type: boolean
          description: Need quiesce Instance or not when taking Snapshot
        serviceofferingdisplaytext:
          type: string
          description: The display text of the service offering for root disk
        serviceofferingid:
          type: string
          description: ID of the service offering for root disk
        serviceofferingname:
          type: string
          description: Name of the service offering for root disk
        size:
          type: integer
          format: int64
          description: Size of the disk volume
        sizegb:
          type: string
          description: Disk size in GiB
        snapshotid:
          type: string
          description: ID of the Snapshot from which this volume was created
        state:
          type: string
          description: The state of the disk volume
        status:
          type: string
          description: The status of the volume
        storage:
          type: string
          description: Name of the primary storage hosting the disk volume
        storageid:
          type: string
          description: ID of the primary storage hosting the disk volume; returned to admin User only
        storagetype:
          type: string
          description: Shared or local storage
        supportsstoragesnapshot:
          type: boolean
          description: True if storage Snapshot is supported for the volume, false otherwise
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated
        templatedisplaytext:
          type: string
          description: An alternate display text of the Template for the Instance
        templateid:
          type: string
          description: The ID of the Template for the Instance. A -1 is returned if the Instance was created from an ISO file.
        templatename:
          type: string
          description: The name of the Template for the Instance
        type:
          type: string
          description: Type of the disk volume (ROOT or DATADISK)
        utilization:
          type: string
          description: The disk utilization
        virtualmachineid:
          type: string
          description: ID of the Instance
        virtualsize:
          type: integer
          format: int64
          description: The bytes allocated
        vmdisplayname:
          type: string
          description: Display name of the Instance
        vmname:
          type: string
          description: Name of the Instance
        vmstate:
          type: string
          description: State of the Instance
        vmtype:
          type: string
          description: Type of the Instance
        volumecheckresult:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: details for the volume check result, they may vary for different hypervisors
        volumerepairresult:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: details for the volume repair result, they may vary for different hypervisors
        zoneid:
          type: string
          description: ID of the availability zone
        zonename:
          type: string
          description: Name of the availability zone
    VolumesUsageHistory:
      type: object
      properties:
        id:
          type: string
          description: The ID of the volume
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the volume
        stats:
          type: array
          items: {}
          x-cloudstack-type: list
          description: The list of VM stats
    VpnConnection:
      type: object
      properties:
        account:
          type: string
          description: The owner
        cidrlist:
          type: string
          description: Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
        created:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        domain:
          type: string
          description: The domain name of the owner
        domainid:
          type: string
          description: The domain id of the owner
        domainpath:
          type: string
          description: the domain path of the owner
        dpd:
          type: boolean
          description: If DPD is enabled for customer gateway
        esplifetime:
          type: integer
          format: int64
          description: Lifetime of ESP SA of customer gateway
        esppolicy:
          type: string
          description: ESP policy of the customer gateway
        forceencap:
          type: boolean
          description: If Force NAT Encapsulation is enabled for customer gateway
        fordisplay:
          type: boolean
          description: Is connection for display to the regular user
        gateway:
          type: string
          description: Public IP address id of the customer gateway
        id:
          type: string
          description: The connection ID
        ikelifetime:
          type: integer
          format: int64
          description: Lifetime of IKE SA of customer gateway
        ikepolicy:
          type: string
          description: IKE policy of the customer gateway
        ikeversion:
          type: string
          description: Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
        ipsecpsk:
          type: string
          description: IPsec Preshared-Key of the customer gateway
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        passive:
          type: boolean
          description: State of VPN connection
        project:
          type: string
          description: The project name
        projectid:
          type: string
          description: The project id
        publicip:
          type: string
          description: The public IP address
        removed:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        s2scustomergatewayid:
          type: string
          description: The customer gateway ID
        s2svpngatewayid:
          type: string
          description: The VPN gateway ID
        splitconnections:
          type: boolean
          description: Split multiple remote Networks into multiple phase 2 SAs. Often used with Cisco some products.
        state:
          type: string
          description: State of VPN connection
    VpnCustomerGateway:
      type: object
      properties:
        account:
          type: string
          description: The owner
        cidrlist:
          type: string
          description: Guest CIDR list of the customer gateway. Multiple entries are separated by a single comma character (,).
        domain:
          type: string
          description: The domain name of the owner
        domainid:
          type: string
          description: The domain ID of the owner
        domainpath:
          type: string
          description: The domain path of the owner
        dpd:
          type: boolean
          description: If DPD is enabled for customer gateway
        esplifetime:
          type: integer
          format: int64
          description: Lifetime of ESP SA of customer gateway
        esppolicy:
          type: string
          description: IPsec policy of customer gateway
        excludedparameters:
          type: string
          description: Contains the list of excluded/not allowed cryptographic parameters that the vpn customer gateway is using.
        forceencap:
          type: boolean
          description: If Force NAT Encapsulation is enabled for customer gateway
        gateway:
          type: string
          description: Public IP address ID of the customer gateway
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        id:
          type: string
          description: The VPN gateway ID
        ikelifetime:
          type: integer
          format: int64
          description: Lifetime of IKE SA of customer gateway
        ikepolicy:
          type: string
          description: IKE policy of customer gateway
        ikeversion:
          type: string
          description: Which IKE Version to use, one of ike (autoselect), IKEv1, or IKEv2. Defaults to ike
        ipaddress:
          type: string
          description: Guest IP of the customer gateway
        ipsecpsk:
          type: string
          description: IPsec preshared-key of customer gateway
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: Name of the customer gateway
        obsoleteparameters:
          type: string
          description: Contains the list of obsolete/insecure cryptographic parameters that the vpn customer gateway is using.
        project:
          type: string
          description: The project name
        projectid:
          type: string
          description: The project ID
        removed:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        splitconnections:
          type: boolean
          description: For IKEv2, whether to split multiple right subnet CIDRs into multiple connection statements.
    VpnGateway:
      type: object
      properties:
        account:
          type: string
          description: The owner
        domain:
          type: string
          description: The domain name of the owner
        domainid:
          type: string
          description: The domain id of the owner
        domainpath:
          type: string
          description: the domain path of the owner
        fordisplay:
          type: boolean
          description: Is VPN gateway for display to the regular user
        id:
          type: string
          description: The VPN gateway ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        project:
          type: string
          description: The project name
        projectid:
          type: string
          description: The project id
        publicip:
          type: string
          description: The public IP address
        removed:
          type: string
          x-cloudstack-type: date
          description: The date and time the host was removed. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        vpcid:
          type: string
          description: The VPC id of this gateway
        vpcname:
          type: string
          description: The VPC name of this gateway
    VpnUser:
      type: object
      properties:
        account:
          type: string
          description: The Account of the remote access VPN
        domain:
          type: string
          description: The domain name of the Account of the remote access VPN
        domainid:
          type: string
          description: The domain ID of the Account of the remote access VPN
        domainpath:
          type: string
          description: Path of the domain to which the remote access VPN belongs
        id:
          type: string
          description: The VPN user ID
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        project:
          type: string
          description: The project name of the VPN
        projectid:
          type: string
          description: The project ID of the VPN
        state:
          type: string
          description: The state of the VPN User, can be 'Add', 'Revoke' or 'Active'.
        username:
          type: string
          description: The username of the VPN user
    VsphereStoragePolicy:
      type: object
      properties:
        description:
          type: string
          description: The description of the Storage Policy
        id:
          type: string
          description: The ID of the Storage Policy
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the Storage Policy
        policyid:
          type: string
          description: The identifier of the Storage Policy in vSphere DataCenter
        zoneid:
          type: string
          description: The ID of the Zone
    Webhook:
      type: object
      properties:
        account:
          type: string
          description: The account associated with the Webhook
        created:
          type: string
          x-cloudstack-type: date
          description: The date when this Webhook was created. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        description:
          type: string
          description: The description of the Webhook
        domain:
          type: string
          description: The name of the domain in which the Webhook exists
        domainid:
          type: string
          description: The ID of the domain in which the Webhook exists
        domainpath:
          type: string
          description: path of the domain to which the Webhook belongs
        id:
          type: string
          description: The ID of the Webhook
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        name:
          type: string
          description: The name of the Webhook
        payloadurl:
          type: string
          description: The payload URL end point for the Webhook
        project:
          type: string
          description: the project name of the Kubernetes cluster
        projectid:
          type: string
          description: the project id of the Kubernetes cluster
        scope:
          type: string
          description: The scope of the Webhook
        secretkey:
          type: string
          description: The secret key for the Webhook
        sslverification:
          type: boolean
          description: Whether SSL verification is enabled for the Webhook
        state:
          type: string
          description: The state of the Webhook
    WebhookFilter:
      type: object
      properties:
        created:
          type: string
          x-cloudstack-type: date
          description: The type of the Webhook filter. CloudStack date, ISO 8601 with a numeric offset, for example "2026-07-29T11:18:10+0000".
        id:
          type: string
          description: The ID of the Webhook filter
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        matchtype:
          type: string
          description: The type of the Webhook filter
        mode:
          type: string
          description: The type of the Webhook filter
        type:
          type: string
          description: The type of the Webhook filter
        value:
          type: string
          description: The type of the Webhook filter
        webhookid:
          type: string
          description: The ID of the Webhook
        webhookname:
          type: string
          description: The name of the Webhook
    Zone:
      type: object
      properties:
        allocationstate:
          type: string
          description: The allocation state of the cluster
        allowuserspecifyvrmtu:
          type: boolean
          description: Allow end users to specify VR MTU
        asnrange:
          type: string
          description: AS Number Range
        capacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          x-cloudstack-type: list
          description: The capacity of the Zone
        description:
          type: string
          description: Zone description
        dhcpprovider:
          type: string
          description: The DHCP Provider for the Zone
        displaytext:
          type: string
          description: The display text of the zone
        dns1:
          type: string
          description: The first DNS for the Zone
        dns2:
          type: string
          description: The second DNS for the Zone
        domain:
          type: string
          description: Network domain name for the Networks in the zone
        domainid:
          type: string
          description: The UUID of the containing domain, null for public zones
        domainname:
          type: string
          description: The name of the containing domain, null for public zones
        gputotal:
          type: integer
          format: int64
          description: Total GPUs in the Zone
        gpuused:
          type: integer
          format: int64
          description: Used GPUs in the Zone
        guestcidraddress:
          type: string
          description: The guest CIDR address for the Zone
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: Zone id
        internaldns1:
          type: string
          description: The first internal DNS for the Zone
        internaldns2:
          type: string
          description: The second internal DNS for the Zone
        ip6dns1:
          type: string
          description: The first IPv6 DNS for the Zone
        ip6dns2:
          type: string
          description: The second IPv6 DNS for the Zone
        ismultiarch:
          type: boolean
          description: True, if zone contains clusters and hosts from different CPU architectures
        isnsxenabled:
          type: boolean
          description: True, if zone is NSX enabled
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        localstorageenabled:
          type: boolean
          description: True if local storage offering enabled, false otherwise
        name:
          type: string
          description: Zone name
        networktype:
          type: string
          description: The Network type of the zone; can be Basic or Advanced
        provider:
          type: string
          description: External network provider if any
        resourcedetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Meta data associated with the zone (key/value pairs)
        routedmodeenabled:
          type: boolean
          description: True, if routed Network/VPC is enabled
        routerprivateinterfacemaxmtu:
          type: integer
          format: int32
          description: The maximum value the MTU can have on the VR's private interfaces
        routerpublicinterfacemaxmtu:
          type: integer
          format: int32
          description: The maximum value the MTU can have on the VR's public interfaces
        securitygroupsenabled:
          type: boolean
          description: True if security groups support is enabled, false otherwise
        storageaccessgroups:
          type: string
          description: comma-separated list of storage access groups for the zone
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated with zone.
        type:
          type: string
          description: The type of the zone - core or edge
        zonetoken:
          type: string
          description: Zone Token
    ZonesMetric:
      type: object
      properties:
        allocationstate:
          type: string
          description: The allocation state of the cluster
        allowuserspecifyvrmtu:
          type: boolean
          description: Allow end users to specify VR MTU
        asnrange:
          type: string
          description: AS Number Range
        capacity:
          type: array
          items:
            $ref: '#/components/schemas/Capacity'
          x-cloudstack-type: list
          description: The capacity of the Zone
        clusters:
          type: string
          description: Healthy / total clusters in the zone
        cpuallocated:
          type: string
          description: The total cpu allocated in Ghz
        cpuallocateddisablethreshold:
          type: boolean
          description: CPU allocated disable threshold exceeded
        cpuallocatedthreshold:
          type: boolean
          description: CPU allocated notification threshold exceeded
        cpudisablethreshold:
          type: boolean
          description: CPU usage disable threshold exceeded
        cpumaxdeviation:
          type: string
          description: The maximum cpu deviation
        cputhreshold:
          type: boolean
          description: CPU usage notification threshold exceeded
        cputotal:
          type: string
          description: The total cpu capacity in Ghz
        cpuused:
          type: string
          description: The total cpu used in Ghz
        description:
          type: string
          description: Zone description
        dhcpprovider:
          type: string
          description: The DHCP Provider for the Zone
        displaytext:
          type: string
          description: The display text of the zone
        dns1:
          type: string
          description: The first DNS for the Zone
        dns2:
          type: string
          description: The second DNS for the Zone
        domain:
          type: string
          description: Network domain name for the Networks in the zone
        domainid:
          type: string
          description: The UUID of the containing domain, null for public zones
        domainname:
          type: string
          description: The name of the containing domain, null for public zones
        gputotal:
          type: integer
          format: int64
          description: Total GPUs in the Zone
        gpuused:
          type: integer
          format: int64
          description: Used GPUs in the Zone
        guestcidraddress:
          type: string
          description: The guest CIDR address for the Zone
        hasannotations:
          type: boolean
          description: True if the entity/resource has annotations
        icon:
          type: object
          x-cloudstack-type: resourceiconresponse
          description: Base64 string representation of the resource icon
        id:
          type: string
          description: Zone id
        internaldns1:
          type: string
          description: The first internal DNS for the Zone
        internaldns2:
          type: string
          description: The second internal DNS for the Zone
        ip6dns1:
          type: string
          description: The first IPv6 DNS for the Zone
        ip6dns2:
          type: string
          description: The second IPv6 DNS for the Zone
        ismultiarch:
          type: boolean
          description: True, if zone contains clusters and hosts from different CPU architectures
        isnsxenabled:
          type: boolean
          description: True, if zone is NSX enabled
        jobid:
          type: string
          description: The UUID of the latest async job acting on this object
        jobstatus:
          type: integer
          format: int32
          description: The current status of the latest async job acting on this object
        localstorageenabled:
          type: boolean
          description: True if local storage offering enabled, false otherwise
        memoryallocated:
          type: string
          description: The total cpu allocated in GiB
        memoryallocateddisablethreshold:
          type: boolean
          description: Memory allocated disable threshold exceeded
        memoryallocatedthreshold:
          type: boolean
          description: Memory allocated notification threshold exceeded
        memorydisablethreshold:
          type: boolean
          description: Memory usage disable threshold exceeded
        memorymaxdeviation:
          type: string
          description: The maximum memory deviation
        memorythreshold:
          type: boolean
          description: Memory usage notification threshold exceeded
        memorytotal:
          type: string
          description: The total cpu capacity in GiB
        memoryused:
          type: string
          description: The total cpu used in GiB
        name:
          type: string
          description: Zone name
        networktype:
          type: string
          description: The Network type of the zone; can be Basic or Advanced
        provider:
          type: string
          description: External network provider if any
        resourcedetails:
          type: object
          additionalProperties: {}
          x-cloudstack-type: map
          description: Meta data associated with the zone (key/value pairs)
        routedmodeenabled:
          type: boolean
          description: True, if routed Network/VPC is enabled
        routerprivateinterfacemaxmtu:
          type: integer
          format: int32
          description: The maximum value the MTU can have on the VR's private interfaces
        routerpublicinterfacemaxmtu:
          type: integer
          format: int32
          description: The maximum value the MTU can have on the VR's public interfaces
        securitygroupsenabled:
          type: boolean
          description: True if security groups support is enabled, false otherwise
        state:
          type: string
          description: State of the cluster
        storageaccessgroups:
          type: string
          description: comma-separated list of storage access groups for the zone
        tags:
          type: array
          items:
            $ref: '#/components/schemas/Tags'
          x-cloudstack-type: set
          description: The list of resource tags associated with zone.
        type:
          type: string
          description: The type of the zone - core or edge
        zonetoken:
          type: string
          description: Zone Token