Create a New VM

Create a virtual machine with the given parameters.

The request waits until the VM is ready, then returns the VM as JSON.

Progress is a separate Server-Sent Events stream. Subscribe with the same sequence_id from this request body at GET /v1/events/create-vm/{sequence_id}.

Authorization

bearer_auth

AuthorizationBearer <token>

OAuth Authentication

OpenScaler API uses OAuth, a standard for secure authorization. To access the API, obtain a token via the OpenScaler Platform.

Use the access_token in the Authorization header for requests:

Authorization: Bearer <token>

Always keep your token secure and do not share it with anyone.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Create a VM using a predefined size flavor.

size*VmSize

one of predefined sizes/flavors, see VM Sizes/Flavors section.

project_id*ProjectId

A globally unique identifier for a project (where resource is placed) - or "default" for your default project. Projects are used as workspaces to organize things and separate resources for different independent purposes.

name*VmName

Human readable name for the VM (user can set it manually), preferably unique per user. Try suggesting initial name based on the size/flavor of the VM, its region, and and a unique index number (e.g. if user already has 3 VMs in the same region with same flavor, new VM would have number 4), e.g. : "my-example-computer" (distro flavor/resources region vm-index).

This will also be used as hostname when creating the VM, so it should be a valid hostname : lowercase letters, numbers or hyphens with max length of 253. Must also not start with a hyphen.

Match^[a-z0-9][a-z0-9-]+$

Lengthlength <= 255

sequence_id*integer

Random number you choose to correlate this create request with progress on GET /v1/events/create-vm/{sequence_id}.

description?|

VM description given by user

region*RegionCreateRequest

Region where this resource will be created. One of the available regions, see Regions section for more information.

distro?"debian-13"

Identifier of the OS distribution.

Value in

"debian-13"

template_id?string

Optional ID of a user or marketplace template to create the VM from. When set, this takes precedence over distro for the image source. Either distro or template_id must be provided.

vpc_id?string

The ID of the VPC to which the VM will be assigned. See VPCs section for more details.

If excluded, the VM will be assigned to the user's default VPC for the region.

Formatuuid

ssh_key_ids?array<string>

IDs of stored SSH keys to embed in the VM's root account upon creation.

Prefer this over deprecated ssh_keys. Required unless password is set.

ssh_keys?array<string>

Deprecated

Deprecated. Raw SSH public key material. Prefer ssh_key_ids.

password?VmCreatePassword

Encrypted Password to be set for the VM. The use of password is discouraged in favor of SSH keys.

allow_root_ssh_password_access?boolean

If true, allow root SSH login with the provided password.

Defaultfalse

cloud_init_user_data?CloudInitUserData

A string containing cloud-init 'user data' which may be used to configure the VM on first boot, often a 'cloud-config' file or Bash script. It must be plain text and may not exceed 64 KiB in size.

attached_disks?array<>

Optional additional disks to attach at creation time.

Response Body

`application/json`

`text/pain`

`application/json`

curl -X POST "https://example.com/v1/vms" \  -H "Content-Type: application/json" \  -d '{    "size": "b-1-500mb-10",    "project_id": "default",    "name": "my-example-computer",    "sequence_id": 123456,    "description": "My example computer (generated from API)",    "region": "alg1",    "distro": "debian-13",    "ssh_key_ids": [      "key_abc123"    ],    "password": "strong_password",    "allow_root_ssh_password_access": false,    "cloud_init_user_data": "",    "attached_disks": [      {        "sizeGB": 5      }    ]  }'

{  "id": "cc3ccab2-0ae2-11ef-9136-6a0922f6458b",  "name": "my-example-computer",  "user_id": "7247ba6a-b17d-4c72-94f1-a36108aee56d",  "project_id": "default",  "uuid": "cc8b9d3c-fe4d-11ee-91c9-6aca7850c3b4",  "region": "alg1",  "description": "My example computer (generated from API)",  "distro": "debian-13",  "size": "b-1-500mb-10",  "memoryMB": 1024,  "vcpus": 1,  "storageGB": 161061273600,  "transferGB": 1000,  "vpc_id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",  "node_type": "VM",  "created_at": "2024-04-19T13:07:39",  "updated_at": "2024-04-19T13:07:39"}

{  "errors": [    {      "message": "'vcpus' field must be an integer",      "field": "resource_id"    }  ]}

"Access denied"

{  "errors": [    {      "message": "User not initialized (missing required fields in token), please init user by sending POST request to `/v1/init` then refresh your token\n"    }  ]}

{  "errors": [    {      "message": "VM with ID 23 not found"    }  ]}

Authorization

OAuth Authentication

Request Body

Response Body

201application/json

400application/json

403text/pain

444application/json

500application/json

`application/json`

`application/json`

`text/pain`

`application/json`

`application/json`