Skip to main content
GET
List Vms

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.

Query Parameters

include_provisioning
boolean
default:true
include_ready
boolean
default:true
include_failed
boolean
default:true
include_terminated
boolean
default:true

Response

Successful Response

Response model for listing VMs.

vms
VMResponse · object[]
required
total
integer
required