Skip to main content
POST
Create Vm

Authorizations

Authorization
string
header
required

Pass an API key (prefixed lk_) or a JWT access token as a bearer token. Generate API keys in the dashboard at https://dashboard.lyceum.technology/api-keys.

Body

application/json

Request model for creating a new VM.

user_public_key
string
required
Minimum string length: 1
hardware_profile
string
required
instance_specs
Instance Specs · object | null
display_name
string | null
instance_type
enum<string>
default:on-demand
Available options:
on-demand,
spot

Response

Successful Response

Response model for VM operations.

vm_id
string
required
status
string
required
created_at
string<date-time>
required
instance_specs
Instance Specs · object
required
ip_address
string | null
hardware_profile
string | null
gpu_count
integer | null
instance_type
string | null
name
string | null
display_name
string | null
billed
number | null
croesus_billed
number | null
status_check_url
string | null
polling_message
string | null
user_id
string | null
org_id
string | null