Create VM Instances

Creates one virtual machines with the specified custom configuration and features provided in the request body.

HTTP Request

POST {API_URL}virtual-machines

Body parameters

Parameters	Requirements	Type	Description
name	Required	string	Name of the virtual machine being deployed.
image_id	Required	string	Id of the operating system image to be installed on your virtual machine. Use the GET /images endpoint to retrieve a list of images offered by API.
flavor_id	Required	string	Id of the flavor corresponding to the hardware configuration (CPUs, memory, GPUs, storage and network devices) for your virtual machine. Use the GET /flavors endpoint to retrieve a list of available flavors.
ssh_key	Required	Object	Detail of the SSH keypair to be used in gaining secure access to the virtual machine. e.g., {"name":"sshkey","public_key":"ssh-ed25519 AAAA"}
init_script	Optional	string	Custom scripts to be executed on virtual machine deployment.

NOTE

image_id and flavor_id must be from the same region; otherwise, creation will fail.

init_script

Custom scripts within the init_script field, at the time of launch, a virtual machine with the configurations specified in the cloud-config script will be created.

In this example the following cloud-config is sent:

#!/bin/bash\n\nsudo apt-get update\nsudo apt-get install -y ca-certificates curl gnupg\nsudo install -m 0755 -d /etc/apt/keyrings\ncurl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --yes --dearmor -o /etc/apt/keyrings/docker.gpg\nsudo chmod a+r /etc/apt/keyrings/docker.gpg\n\necho \\\n\"deb [arch=\"$(dpkg --print-architecture)\" signed-by=/etc/apt/keyrings/docker.gpg] https://download.docker.com/linux/ubuntu \\\n\"$(. /etc/os-release && echo \"$VERSION_CODENAME\")\" stable\" | \\\nsudo tee /etc/apt/sources.list.d/docker.list > /dev/null\nsudo apt-get update\n\nsudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin\n\nsudo usermod -aG docker ubuntu\nsudo apt-get install nvidia-container-toolkit -y\n\nsudo nvidia-ctk runtime configure --runtime=docker\nsudo systemctl restart docker

This configuration will install Docker packages on your virtual machine and run a test container that uses your NVIDIA GPUs.

Reponse Attributes

status boolean

Indicates the result of the request to create virtual machine. true signifies success, while false indicates an error.

message string

A description of the status of the request.

data object

An instance object, containing name and id about the request to create virtual machine.

For descriptions of the fields within the instances object returned in response to your request, please refer to the documentation here.

Example

Request

curl -X POST '{API_URL}virtual-machines' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'refresh-token: {REFRESH_TOKEN}' \
-H 'Content-Type: application/json' \
-d '{
    "name":"rtx4090vm",
    "image_id":"66b2d63c9e793247704c5a01",
    "flavor_id":"66b9ca8f6523790d00fea3ca",
    "ssh_key":{
        "name":"sshkey",
        "public_key":"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIB6EQ4uTrwo2w+ZEBBgkAZN9kOX/sWMb5biqCet77m3q sshusername"
    }
}'

Response

{
    "status": true,
    "message": "Creating virtual machine successful",
    "data": {
        "name": "VM-dhSqf5qh",
        "id": "66bd5a1299f01e419f5ad5bc"
    }
}