Skip to main content
POST
/
api
/
v2
/
external
/
vms
/
create
Create VM Instance
curl --request POST \
  --url https://api.lyceum.technology/api/v2/external/vms/create \
  --header 'Content-Type: application/json' \
  --data '
{
  "hardware_profile": "cpu",
  "user_public_key": "<string>",
  "name": "<string>",
  "instance_specs": {
    "cpu": 123,
    "memory": 123,
    "disk": 123,
    "gpu_count": 123
  }
}
'
{
  "vm_id": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "ip_address": "<string>"
}

Body

application/json

Request model for creating a VM instance

hardware_profile
enum<string>
required

Hardware profile for the VM instance

Available options:
cpu,
a100,
h100
user_public_key
string
required

SSH public key for authentication

name
string | null

Friendly name for the VM instance

instance_specs
VMInstanceSpecs · object

Custom resource specifications

Response

Successful Response

Response from creating a VM instance

vm_id
string
required
status
string
required
created_at
string<date-time>
required
name
string | null
ip_address
string | null