Create_Instances_Payload

countintegerrequired

The number of virtual machines to be created.

environment_namestringrequired

The name of the environment in which the virtual machine is to be created.

flavor_namestringrequired

The name of the GPU hardware configuration (flavor) for the virtual machines being created.

key_namestringrequired

The name of the existing SSH key pair to be used for secure access to the virtual machine. For additional information on SSH key pairs, see Key pair endpoints.

namestringrequired

The name of the virtual machine being created.

Max length: 50 characters

image_namestring

The operating system (OS) image name designated for installation on the virtual machine.It also accepts custom, private images, created from existing snapshots.

volume_namestring

The names of the volume(s) to be attached to the virtual machine being created.

create_bootable_volumeboolean

Indicates whether to create a bootable volume for the virtual machine. When set to true, a bootable volume will be created; the default value is false.

flavor object

GPU and CPU configuration of the virtual machine.

cpuinteger

Number of CPU cores.

ramnumber

Memory allocated to the flavor, in GB.

diskinteger

Root disk capacity, in GB.

gpustring

GPU model name. Empty string if the flavor has no GPU.

gpu_countinteger

Number of GPUs attached to the flavor.

user_datastring

Optional initialization configuration commands to manage the configuration of a virtual machine at launch using cloud-init scripts. For more information about custom VM configuration using cloud-init, see Initialization configuration.

callback_urlstring

An optional URL where actions performed on the virtual machine will be sent. For additional information on event callbacks, see Attach a callback to a VM.

Max length: 250 characters

assign_floating_ipboolean

When this field is set to true, it attaches a public IP address to the virtual machine, enabling internet accessibility.

enable_port_randomizationboolean

Indicates whether to enable port randomization.This setting is only effective if 'assign_floating_ip' is true. Defaults to true.

Default: true

security_rules object[]

Firewall rules to apply to the VM at creation.

Array [

directionstringrequired

The direction of traffic that the firewall rule applies to.

ethertypestringrequired

The Ethernet type associated with the rule.

protocolstringrequired

The network protocol associated with the rule. Call the List firewall rule protocols endpoint to retrieve a list of permitted network protocols.

Possible values: [any, ah, dccp, egp, esp, gre, hopopt, icmp, igmp, ip, ipip, ipv6-encap, ipv6-frag, ipv6-icmp, icmpv6, ipv6-nonxt, ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, udp, udplite, vrrp]

Example: any

remote_ip_prefixstringrequired

The IP address range that is allowed to access the specified port. Use "0.0.0.0/0" to allow any IP address.

]

profile object

An object containing the configuration of the virtual machine saved in the created profile.

namestringrequired

Resource name.

descriptionstring

Human-readable description of the resource.

labelsstring[]

Optional user-supplied tags for grouping or filtering.

Create_Instances_Payload

{
  "count": 0,
  "environment_name": "string",
  "flavor_name": "string",
  "key_name": "string",
  "name": "string",
  "image_name": "string",
  "volume_name": "string",
  "create_bootable_volume": true,
  "flavor": {
    "cpu": 0,
    "ram": 0,
    "disk": 0,
    "gpu": "string",
    "gpu_count": 0
  },
  "user_data": "string",
  "callback_url": "string",
  "assign_floating_ip": true,
  "enable_port_randomization": true,
  "security_rules": [
    {
      "direction": "string",
      "ethertype": "string",
      "protocol": "any",
      "remote_ip_prefix": "string"
    }
  ],
  "profile": {
    "name": "string",
    "description": "string"
  },
  "labels": [
    "string"
  ]
}