Skip to main content

CreateVmRequest

Request body for creating a new virtual machine.

tariffIdstring<uuid>

Id of the compute tariff (CPU/RAM/disk plan) to provision the VM with.

pluginsstring<uuid>[]nullable

Ids of plugins to install on the VM.

imageIdstring<uuid>

Id of the OS image to install on the VM.

vmNamestringnullable

Host name for the VM. Must be non-empty, at most 253 characters, and FQDN-like: each dot-separated label must be non-empty, at most 63 characters, contain only letters, digits and hyphens, and must not start or end with a hyphen.

sshPublicKeysstring[]nullable

Inline SSH public keys to authorize on the VM, in addition to any referenced by SshKeyIds. At most 10 entries; each must be non-empty, at most 8192 characters, and start with a supported key type (e.g. ssh-rsa, ssh-ed25519, ssh-dss, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521, sk-ssh-ed25519@openssh.com, sk-ecdsa-sha2-nistp256@openssh.com).

sshKeyIdsstring<uuid>[]nullable

Ids of previously registered SSH keys to authorize on the VM. At most 10 entries.

publicIpTariffIdstring<uuid>nullable

Id of the public IP tariff used to purchase a new public IP. Only allowed when PublicIpMode is New; must be omitted otherwise.

publicIpModePublicIpMode (string)

Strategy that defines how the public IP should be assigned.

Possible values: [New, Existing, None]

existingPublicIpIdstring<uuid>nullable

Id of an existing public IP to attach to the VM. Required when PublicIpMode is Existing; must be omitted otherwise.

privateNetworkIdsstring<uuid>[]nullable

Ids of existing private networks to attach the VM to. Must not contain duplicates or empty GUIDs. The combined count of PrivateNetworkIds and NewNetworks must not exceed 10.

newNetworks object[]nullable

New private networks to create and attach the VM to (subject to the combined 10-network limit described on PrivateNetworkIds).

  • Array [
    • namestringnullable

    Name of the new network. Must be non-empty, at most 128 characters, and contain only letters, digits, hyphens, underscores and spaces.

  • ]
    • CreateVmRequest
    {
      "tariffId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "plugins": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "imageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "vmName": "string",
      "sshPublicKeys": [
        "string"
      ],
      "sshKeyIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "publicIpTariffId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "publicIpMode": "New",
      "existingPublicIpId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "privateNetworkIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "newNetworks": [
        {
          "name": "string"
        }
      ]
    }