Skip to main content

Create virtual machine API​

Select

SaaS
Customer Managed

Create Virtual Machine

Request Body
  • name string

    Name of VM

  • description string

    VM description

  • expirationTime int32

    VM expiration time in UNIX timestamp format

  • count int32

    Number of VMs to be created

  • userDetails object
  • name string

    username to access the network path

  • password string

    password to access the network path

  • target object
  • id int32
  • name string
  • template object
  • vmName string

    VM name of template

  • vmGUID string

    VM guid of template

  • operatingSystem string

    Possible values: [WINDOWS, UNIX]

    OS types

  • operatingSystemDisplayName string

    Operating System version

  • memory int64

    Memory size of VM in GBs

  • numCPUs int32

    Number of CPUs for VM

  • numNICs int32

    Number of NICs associated to VM

  • vmSize string

    VM instance

  • createPublicIP boolean

    Is public IP enabled

  • vmIOPS int32

    IOPS limit for Amazon VM

  • isoPath string

    ISO path for HyperV VM

  • vmBackup boolean

    Enable VM backup

  • vmDisk object[]

    New disk configuration

  • name string

    Name of the disk

  • snapshotId string

    Unique identifier of the snapshot, applicable if the disk is created from a snapshot

  • provisioningType string

    Possible values: [THIN, THICK]

    Disk provisioning type

  • diskSize int64

    Disk size in bytes

  • diskType string

    Possible values: [ISCSI, IDE]

    Type of disk controller

  • sourceHardDiskType SourceHardDiskType

    Possible values: [None, EmptyHardDisk, ExistingHardDisk, ExistingSnapShot, RootHardDisk]

    Type of hard disk

  • network object[]
  • networkDisplayName string

    Selected network display name

  • network string

    Name of network switch

  • subnetId string

    Subnet id of the subnet

  • networkId string

    VPC id for the amazon network

  • destinationNetworks string[]

    Destination network name

  • networkNames string[]

    Name of network to which the nic is connected

  • domainOptions object
  • domainName string

    Unique name for network domain

  • OUPath string

    Organizational unit path of VM

Responses

OK

Schema
  • taskId int32
  • jobIds string[]

    JobIds for the immediate run request

Loading...