API

Appearance

VM Instances ​

API operations for creating and managing virtual machine resources and their associated features.

The instances object ​

The response to virtual machine endpoint API requests includes the instances object, which provides comprehensive details about your virtual machines.

Attributes ​

id string ​

The unique identifier for the virtual machine.

name string ​

The name of the virtual machine.

status string ​

The current status of the virtual machine (e.g., "running"). All states include creating, running, deleting, starting, stopping, stopped, rebooting.

login object ​

An object containing information about the login info with the virtual machine.

{
    "_id": "66bd5a1299f01e419f5ad5bd",
    "ssh_key": {
        "id": "66bd5a0799f01e419f5ad5b6",
        "name": "sshkey"
    },
    "password": "password",
    "username": "username"
}

flavor object ​

An object containing details about the flavor (hardware configuration) of the virtual machine.

 {
    "name": "1 x RTX4090",
    "cpu": 16,  // GB
    "ram": 32,  // GB
    "disk": 250,  // GB
    "gpu": "RTX4090",
    "gpu_count": 1
}

fixed_ip string ​

The fixed IP address assigned to the virtual machine.

image object ​

An object containing information about the operating system image installed on the virtual machine.

{
    "name": "Ubuntu-22.04"
}

region object ​

An object containing information about the distinct geographic location.

{
    "name": "DALLAS"
}

started_time date-time ​

The timestamp when the virtual machine was created.